cfgutil

Documentation

Index

• Variables
• func FileExists(filePath string) (bool, error)
• func NormalizeAddress(addr string, defaultPort string) (hostport string, e error)
• func NormalizeAddresses(addrs []string, defaultPort string) ([]string, error)
• type AmountFlag
  • func NewAmountFlag(defaultValue util.Amount) *AmountFlag
  • func (a *AmountFlag) MarshalFlag() (string, error)
  • func (a *AmountFlag) UnmarshalFlag(value string) (e error)
• type ExplicitString
  • func NewExplicitString(defaultValue string) *ExplicitString
  • func (e *ExplicitString) ExplicitlySet() bool
  • func (e *ExplicitString) MarshalFlag() (string, error)
  • func (e *ExplicitString) UnmarshalFlag(value string) (e error)

Variables

var F, E, W, I, D, T logg.LevelPrinter = logg.GetLogPrinterSet(subsystem)

Functions

func FileExists

func FileExists(filePath string) (bool, error)

FileExists reports whether the named file or directory exists.

func NormalizeAddress

func NormalizeAddress(addr string, defaultPort string) (hostport string, e error)

NormalizeAddress returns the normalized form of the address, adding a default port if necessary. An error is returned if the address, even without a port, is not valid.

func NormalizeAddresses

func NormalizeAddresses(addrs []string, defaultPort string) ([]string, error)

NormalizeAddresses returns a new slice with all the passed peer addresses normalized with the given default port, and all duplicates removed.

Types

type AmountFlag

type AmountFlag struct {
	util.Amount
}

AmountFlag embeds a util.Amount and implements the flags.Marshaler and Unmarshaler interfaces so it can be used as a config struct field.

func NewAmountFlag

func NewAmountFlag(defaultValue util.Amount) *AmountFlag

NewAmountFlag creates an AmountFlag with a default util.Amount.

func (*AmountFlag) MarshalFlag

func (a *AmountFlag) MarshalFlag() (string, error)

MarshalFlag satisifes the flags.Marshaler interface.

func (*AmountFlag) UnmarshalFlag

func (a *AmountFlag) UnmarshalFlag(value string) (e error)

UnmarshalFlag satisifes the flags.Unmarshaler interface.

type ExplicitString

type ExplicitString struct {
	Value string
	// contains filtered or unexported fields
}

ExplicitString is a string value implementing the flags.Marshaler and flags.Unmarshaler interfaces so it may be used as a config struct field. It records whether the value was explicitly set by the flags package.

This is useful when behavior must be modified depending on whether a flag was set by the user or left as a default.

Without recording this, it would be impossible to determine whether flag with a default value was unmodified or explicitly set to the default.

func NewExplicitString

func NewExplicitString(defaultValue string) *ExplicitString

NewExplicitString creates a string flag with the provided default value.

func (*ExplicitString) ExplicitlySet

func (e *ExplicitString) ExplicitlySet() bool

ExplicitlySet returns whether the flag was explicitly set through the flags.Unmarshaler interface.

func (*ExplicitString) MarshalFlag

func (e *ExplicitString) MarshalFlag() (string, error)

MarshalFlag implements the flags.Marshaler interface.

func (*ExplicitString) UnmarshalFlag

func (e *ExplicitString) UnmarshalFlag(value string) (e error)

UnmarshalFlag implements the flags.Unmarshaler interface.