text

Documentation

Index

• func NormalizeFilesystemPath(abs bool, appName string) func(*Opt) error
• func NormalizeNetworkAddress(defaultPort string, userOnly bool) func(*Opt) error
• type Hook
• type Opt
  • func New(m meta.Data, h ...Hook) (o *Opt)
  • func (o *Opt) Expanded() (s string)
  • func (o *Opt) FromString(s string) (e error)
  • func (o *Opt) FromValue(v string) *Opt
  • func (o *Opt) Meta() meta.Metadata
  • func (o *Opt) Path() (p path.Path)
  • func (o *Opt) RunHooks() (e error)
  • func (o *Opt) SetExpanded(s string)
  • func (o *Opt) SetPath(p path.Path)
  • func (o *Opt) String() (s string)
  • func (o *Opt) ToOption() config.Option
  • func (o *Opt) Type() meta.Type
  • func (o *Opt) Value() (c config.Concrete)

Functions

func NormalizeFilesystemPath

func NormalizeFilesystemPath(abs bool, appName string) func(*Opt) error

NormalizeFilesystemPath cleans a directory specification, expands the ~ home folder shortcut, and if abs is set to true, returns the absolute path from filesystem root.

func NormalizeNetworkAddress

func NormalizeNetworkAddress(defaultPort string,
	userOnly bool) func(*Opt) error

NormalizeNetworkAddress checks correctness of a network address specification, and adds a default path if needed, and enforces whether the port requires root permission and clamps it if not.

Types

type Hook

type Hook func(*Opt) error

type Opt

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

func New

func New(m meta.Data, h ...Hook) (o *Opt)

func (*Opt) Expanded

func (o *Opt) Expanded() (s string)

func (*Opt) FromString

func (o *Opt) FromString(s string) (e error)

func (*Opt) FromValue

func (o *Opt) FromValue(v string) *Opt

func (*Opt) Meta

func (o *Opt) Meta() meta.Metadata

func (*Opt) Path

func (o *Opt) Path() (p path.Path)

func (*Opt) RunHooks

func (o *Opt) RunHooks() (e error)

func (*Opt) SetExpanded

func (o *Opt) SetExpanded(s string)

func (*Opt) SetPath

func (o *Opt) SetPath(p path.Path)

func (*Opt) String

func (o *Opt) String() (s string)

func (*Opt) ToOption

func (o *Opt) ToOption() config.Option

func (*Opt) Type

func (o *Opt) Type() meta.Type

func (*Opt) Value

func (o *Opt) Value() (c config.Concrete)