cfgutil

Documentation

Index

• func FileExists(filePath string) (bool, error)
• func NormalizeAddress(addr string, defaultPort string) (hostport string, err error)
• func NormalizeAddresses(addrs []string, defaultPort string) ([]string, error)
• type AddressFlag
  • func NewAddressFlag(defaultValue hcutil.Address) *AddressFlag
  • func (a *AddressFlag) MarshalFlag() (string, error)
  • func (a *AddressFlag) UnmarshalFlag(addr string) error
• type AmountFlag
  • func NewAmountFlag(defaultValue hcutil.Amount) *AmountFlag
  • func (a *AmountFlag) MarshalFlag() (string, error)
  • func (a *AmountFlag) UnmarshalFlag(value string) error
• type CurveFlag
  • func NewCurveFlag(defaultValue CurveID) *CurveFlag
  • func (f *CurveFlag) Curve() elliptic.Curve
  • func (f *CurveFlag) MarshalFlag() (name string, err error)
  • func (f *CurveFlag) UnmarshalFlag(value string) error
• type CurveID
• type ExplicitString
  • func NewExplicitString(defaultValue string) *ExplicitString
  • func (e *ExplicitString) ExplicitlySet() bool
  • func (e *ExplicitString) MarshalFlag() (string, error)
  • func (e *ExplicitString) String() string
  • func (e *ExplicitString) UnmarshalFlag(value string) error

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, err 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 AddressFlag

type AddressFlag struct {
	hcutil.Address
}

AddressFlag embeds a hcutil.Address and implements the flags.Marshaler and Unmarshaler interfaces so it can be used as a config struct field.

func NewAddressFlag

func NewAddressFlag(defaultValue hcutil.Address) *AddressFlag

NewAddressFlag creates an AddressFlag with a default hcutil.Address.

func (*AddressFlag) MarshalFlag

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

MarshalFlag satisifes the flags.Marshaler interface.

func (*AddressFlag) UnmarshalFlag

func (a *AddressFlag) UnmarshalFlag(addr string) error

UnmarshalFlag satisifes the flags.Unmarshaler interface.

type AmountFlag

type AmountFlag struct {
	hcutil.Amount
}

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

func NewAmountFlag

func NewAmountFlag(defaultValue hcutil.Amount) *AmountFlag

NewAmountFlag creates an AmountFlag with a default hcutil.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) error

UnmarshalFlag satisifes the flags.Unmarshaler interface.

type CurveFlag

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

CurveFlag describes a curve and implements the flags.Marshaler and Unmarshaler interfaces so it can be used as a config struct field.

func NewCurveFlag

func NewCurveFlag(defaultValue CurveID) *CurveFlag

NewCurveFlag creates a CurveFlag with a default curve.

func (*CurveFlag) Curve

func (f *CurveFlag) Curve() elliptic.Curve

Curve returns the elliptic.Curve specified by the flag.

func (*CurveFlag) MarshalFlag

func (f *CurveFlag) MarshalFlag() (name string, err error)

MarshalFlag satisifes the flags.Marshaler interface.

func (*CurveFlag) UnmarshalFlag

func (f *CurveFlag) UnmarshalFlag(value string) error

UnmarshalFlag satisifes the flags.Unmarshaler interface.

type CurveID

type CurveID int

CurveID specifies a recognized curve through a constant value.

const (
	CurveP224 CurveID = iota
	CurveP256
	CurveP384
	CurveP521
)

Recognized curve IDs.

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) String

func (e *ExplicitString) String() string

String implements the fmt.Stringer interface.

func (*ExplicitString) UnmarshalFlag

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

UnmarshalFlag implements the flags.Unmarshaler interface.