ukargparse

Documentation

Overview

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

SPDX-License-Identifier: BSD-3-Clause Copyright (c) 2022, Unikraft GmbH and The KraftKit Authors. Licensed under the BSD-3-Clause License (the "License"). You may not use this file except in compliance with the License.

Index

• type Param
  • func NewParamStrSlice(lib string, name string, values any) Param
  • func ParamStr(lib string, name string, value any) Param
  • func ParamStrMap(lib string, name string, values any) Param
• type ParamStrSlice
  • func (param *ParamStrSlice) Name() string
  • func (param *ParamStrSlice) Set(value any)
  • func (param *ParamStrSlice) String() string
  • func (param *ParamStrSlice) Value() any
  • func (param *ParamStrSlice) WithValue(value any) Param
• type Params
  • func Parse(args ...string) (Params, error)
  • func (params Params) Contains(needle Param) bool
  • func (params Params) Strings() []string

Types

type Param

type Param interface {
	// The canonical name of the parameter which is understood by Unikraft.
	Name() string

	// Set the value of the parameter.
	Set(any)

	// Get the value of the parameter.
	Value() any

	// String returns the fully qualified parameter ready to be accepted by
	// Unikraft.
	String() string

	// A method-chain mechanism for both setting and getting the Param with the
	// newly embedded value.
	WithValue(any) Param
}

func NewParamStrSlice

func NewParamStrSlice(lib string, name string, values any) Param

NewParamStrSlice instantiates a new Param based on a slice of strings.

func ParamStr

func ParamStr(lib string, name string, value any) Param

ParamStr instantiates a new Param based on a string value.

func ParamStrMap

func ParamStrMap(lib string, name string, values any) Param

ParamStr instantiates a new Param based on a string value.

type ParamStrSlice

type ParamStrSlice struct {
	// contains filtered or unexported fields
}

func (*ParamStrSlice) Name

func (param *ParamStrSlice) Name() string

Name implements Param

func (*ParamStrSlice) Set

func (param *ParamStrSlice) Set(value any)

Set implements Param

func (*ParamStrSlice) String

func (param *ParamStrSlice) String() string

String implements Param

func (*ParamStrSlice) Value

func (param *ParamStrSlice) Value() any

Value implements Param

func (*ParamStrSlice) WithValue

func (param *ParamStrSlice) WithValue(value any) Param

WithValue implements Param

type Params

type Params []Param

func Parse

func Parse(args ...string) (Params, error)

Parse accepts varadic length position argument args which represent Unikraft command-line arguments and returns structured Params.

func (Params) Contains

func (params Params) Contains(needle Param) bool

Contains checks whether the provided needle exists within the existing set of Params.

func (Params) Strings

func (params Params) Strings() []string

Strings returns all parameters and their string representation which is ready to be accepted by Unikraft.