flags

Documentation

Index

• type Common
• type Default
  • func New() *Default
  • func NewWithUsage(additionalUsage string) *Default
  • func (d *Default) ConfigDirectory() string
  • func (d *Default) ConfigFileName() string
  • func (d *Default) Help()
  • func (d *Default) Parse(arguments []string)

Types

type Common

type Common interface {
	ConfigDirectory() string
	ConfigFileName() string
	Parse([]string)
	Help()
}

Common is an interface that defines AP for the common command-line flags used by most Edge services

type Default

type Default struct {
	FlagSet *flag.FlagSet
	// contains filtered or unexported fields
}

Default is the Default implementation of Common used by most Edge services

func New

func New() *Default

New returns a Default struct with an empty additional usage string.

func NewWithUsage

func NewWithUsage(additionalUsage string) *Default

NewWithUsage returns a Default struct.

func (*Default) ConfigDirectory

func (d *Default) ConfigDirectory() string

ConfigDirectory returns the directory where the config file(s) are located, if it was specified.

func (*Default) ConfigFileName

func (d *Default) ConfigFileName() string

ConfigFileName returns the name of the local configuration file

func (*Default) Help

func (d *Default) Help()

Help displays the usage help message and exit.

func (*Default) Parse

func (d *Default) Parse(arguments []string)

Parse parses the passed in command-lie arguments looking to the default set of common flags