snmp

Documentation

Overview

Package snmp implements the 'agent snmp' subcommand.

Index

• func Commands(globalParams *command.GlobalParams) []*cobra.Command
• type OptPairs
• type Options
  • func NewOptions[T any](pairs OptPairs[T]) Options[T]
  • func (o Options[T]) Flag(target *string) OptionsFlag[T]
  • func (o Options[T]) OptsStr() string
  • func (o Options[T]) TypedFlag(target *string, typeName string) OptionsFlag[T]
• type OptionsFlag
  • func (a OptionsFlag[T]) Set(p string) error
  • func (a OptionsFlag[T]) String() string
  • func (a OptionsFlag[T]) Type() string

Functions

func Commands

func Commands(globalParams *command.GlobalParams) []*cobra.Command

Commands returns a slice of subcommands for the 'agent' command.

Types

type OptPairs

type OptPairs[T any] []struct {
	// contains filtered or unexported fields
}

OptPairs is just a useful type alias to avoid writing this out multiple times.

type Options

type Options[T any] struct {
	Options map[string]T
	Order   []string
}

Options represents an ordered map of choices

func NewOptions

func NewOptions[T any](pairs OptPairs[T]) Options[T]

NewOptions creates a new Options object from a set of pairs. We don't just create one directly from a map because map iteration order is random.

func (Options[T]) Flag

func (o Options[T]) Flag(target *string) OptionsFlag[T]

Flag creates a flag using these options and storing the selected choice in target.

func (Options[T]) OptsStr

func (o Options[T]) OptsStr() string

OptsStr provides a '|'-delimited list of all nonempty options.

func (Options[T]) TypedFlag

func (o Options[T]) TypedFlag(target *string, typeName string) OptionsFlag[T]

TypedFlag is the same as Flag but lets you customize how the type of flag is shown in the help.

type OptionsFlag

type OptionsFlag[T any] struct {
	// contains filtered or unexported fields
}

OptionsFlag is an implementation of pflag.Value that complains when set to an invalid option.

func (OptionsFlag[T]) Set

func (a OptionsFlag[T]) Set(p string) error

Set sets the value, returning an error if the given choice isn't valid.

func (OptionsFlag[T]) String

func (a OptionsFlag[T]) String() string

String returns a string representation of this value.

func (OptionsFlag[T]) Type

func (a OptionsFlag[T]) Type() string

Type is how the value is represented in the auto-generated help.