flags

Documentation

Overview

Package flags holds common flags that are shared between our commands.

Index

• func Merge(dst, src *flag.FlagSet)
• func ToSet(s []string) mapset.Set
• func Usage(txt string, flags *flag.FlagSet) string
• type AppendSliceValue
  • func (s *AppendSliceValue) Set(value string) error
  • func (s *AppendSliceValue) String() string
• type FlagMapValue
  • func (h *FlagMapValue) Set(value string) error
  • func (h *FlagMapValue) String() string
• type HTTPFlags
  • func (f *HTTPFlags) APIClient() (*api.Client, error)
  • func (f *HTTPFlags) Addr() string
  • func (f *HTTPFlags) Flags() *flag.FlagSet
  • func (f *HTTPFlags) MergeOntoConfig(c *api.Config)
  • func (f *HTTPFlags) ReadTokenFile() (string, error)
  • func (f *HTTPFlags) SetToken(v string) error
  • func (f *HTTPFlags) SetTokenFile(v string) error
  • func (f *HTTPFlags) Token() string
  • func (f *HTTPFlags) TokenFile() string
• type K8SFlags
  • func (f *K8SFlags) Flags() *flag.FlagSet
  • func (f *K8SFlags) KubeConfig() string
• type StringValue
  • func (s *StringValue) Merge(onto *string)
  • func (s *StringValue) Set(v string) error
  • func (s *StringValue) String() string
• type Usager
  • func (u *Usager) String() string

Functions

func Merge

func Merge(dst, src *flag.FlagSet)

func ToSet

func ToSet(s []string) mapset.Set

ToSet creates a set from s.

func Usage

func Usage(txt string, flags *flag.FlagSet) string

Usage returns a usage string nicely formatted.

Types

type AppendSliceValue

type AppendSliceValue []string

AppendSliceValue implements the flag.Value interface and allows multiple calls to the same variable to append a list.

func (*AppendSliceValue) Set

func (s *AppendSliceValue) Set(value string) error

func (*AppendSliceValue) String

func (s *AppendSliceValue) String() string

type FlagMapValue

type FlagMapValue map[string]string

FlagMapValue is a flag implementation used to provide key=value semantics multiple times.

func (*FlagMapValue) Set

func (h *FlagMapValue) Set(value string) error

func (*FlagMapValue) String

func (h *FlagMapValue) String() string

type HTTPFlags

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

HTTPFlags are flags used to configure communication with a Consul agent.

func (*HTTPFlags) APIClient

func (f *HTTPFlags) APIClient() (*api.Client, error)

func (*HTTPFlags) Addr

func (f *HTTPFlags) Addr() string

func (*HTTPFlags) Flags

func (f *HTTPFlags) Flags() *flag.FlagSet

func (*HTTPFlags) MergeOntoConfig

func (f *HTTPFlags) MergeOntoConfig(c *api.Config)

func (*HTTPFlags) ReadTokenFile

func (f *HTTPFlags) ReadTokenFile() (string, error)

func (*HTTPFlags) SetToken

func (f *HTTPFlags) SetToken(v string) error

func (*HTTPFlags) SetTokenFile

func (f *HTTPFlags) SetTokenFile(v string) error

func (*HTTPFlags) Token

func (f *HTTPFlags) Token() string

func (*HTTPFlags) TokenFile

func (f *HTTPFlags) TokenFile() string

type K8SFlags

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

func (*K8SFlags) Flags

func (f *K8SFlags) Flags() *flag.FlagSet

func (*K8SFlags) KubeConfig

func (f *K8SFlags) KubeConfig() string

type StringValue

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

StringValue provides a flag value that's aware if it has been set.

func (*StringValue) Merge

func (s *StringValue) Merge(onto *string)

Merge will overlay this value if it has been set.

func (*StringValue) Set

func (s *StringValue) Set(v string) error

Set implements the flag.Value interface.

func (*StringValue) String

func (s *StringValue) String() string

String implements the flag.Value interface.

type Usager

type Usager struct {
	Usage string
	Flags *flag.FlagSet
}

func (*Usager) String

func (u *Usager) String() string