gofigure

package module

Go to main page

Versions in this module

v0

v0.3.1

Jun 14, 2023

v0.3.0

Jun 13, 2023

v0.2.6

May 18, 2023

Changes in this version

+ func Cast(value, typeOf any) any

v0.2.5

Apr 28, 2023

Changes in this version

+ var ErrLoadingJSON = errors.New("error loading JSON")

+ var ErrParsingJSON = errors.New("error parsing JSON")

+ func Get(uri string) (map[string]any, error)

v0.2.4

Apr 6, 2023

Changes in this version

type Configuration

+ func (c *Configuration) AddConfigFile(sources Source)

v0.2.3

Apr 4, 2023

v0.2.2

Apr 4, 2023

v0.2.1

Apr 4, 2023

Changes in this version

+ const Reference

v0.2.0

Apr 4, 2023

Changes in this version

type Configuration

+ func (c *Configuration) Report() Report

+ type Line struct

+ Name string

+ Values map[string]any

+ type Report []Line

v0.1.2

Apr 4, 2023

v0.1.1

Apr 4, 2023

Changes in this version

+ const Dev

+ const Unset

+ var BuildTime = Unset

+ var CommitHash = Unset

+ var Identifier = Dev

+ func Build() string

v0.1.0

Apr 4, 2023

Changes in this version

+ const AllSources

+ const CommandLine

+ const Default

+ const DefaultIsSet

+ const EnvVar

+ const Flag

+ const HideSet

+ const HideUnset

+ const HideValue

+ const Invalid

+ const Key

+ const MaskSet

+ const MaskUnset

+ const MaskValue

+ const NamedSources

+ const None

+ const NotSet

+ const ReportValue

+ const Set

+ const ShortFlag

+ var ErrInvalidType = errors.New("invalid type")

+ var ErrInvalidValue = errors.New("invalid value")

+ var ErrLoadingConfig = errors.New("error loading config")

+ var ErrMissingDescription = errors.New("value for Value.Description is empty")

+ var ErrMissingName = errors.New("value for Value.Name is empty")

+ var ErrMissingRequiredOption = errors.New("missing required option")

+ var ErrNilPointer = errors.New("value for Value.Ptr is nil")

+ var ErrParsingConfig = errors.New("error parsing config")

+ var ErrUnexpectedArgument = errors.New("unexpected argument")

+ func Assign(target *T, value any) (err error)

+ func Coerce(value, typeOf any) (r any, err error)

+ func Dereference(in any) any

+ type ConfigError struct

+ Cause error

+ Internal error

+ Parameters Parameters

+ Value any

+ func NewConfigError(cause, internal error, parameters ...Parameter) ConfigError

+ func (c ConfigError) Error() string

+ func (c ConfigError) Format(prefix string) string

+ func (c ConfigError) Unwrap() error

+ type Configuration struct

+ Groups []*Group

+ Help bool

+ Prefix string

+ func NewConfiguration(envPrefix string) *Configuration

+ func (c *Configuration) AddHelp(sources Source)

+ func (c *Configuration) Format(err error) string

+ func (c *Configuration) Group(name string) *Group

+ func (c *Configuration) Log(logger *logrus.Logger)

+ func (c *Configuration) Parse() error

+ func (c *Configuration) ParseUsing(args []string) error

+ func (c *Configuration) Usage() string

+ type External string

+ type Group struct

+ Name string

+ Settings []*Setting

+ func (g *Group) Add(setting *Setting)

+ func (g *Group) Values() map[string]any

+ type Mask uint8

+ func (m Mask) Contains(mask Mask) bool

+ func (m Mask) String() string

+ type Options map[Parameter]any

+ func Environment(prefix string, settings Settings) Options

+ func Flags(args []string) (Options, error)

+ func Load(uri string) (Options, error)

+ func (o Options) String() string

+ type Parameter struct

+ Name string

+ Source Source

+ Stub string

+ func (p Parameter) FullName() string

+ func (p Parameter) Matches(parameter Parameter) bool

+ func (p Parameter) String() string

+ type Parameters []Parameter

+ func NewParameters(name string, sources Source) Parameters

+ func (p Parameters) Format(prefix string) string

+ type Setting struct

+ Mask Mask

+ Parameters Parameters

+ Value *Value

+ func Optional(name, param string, ptr *T, value T, sources Source, mask Mask, ...) *Setting

+ func Required(name, param string, ptr *T, sources Source, mask Mask, description string) *Setting

+ func (s Setting) Accepts(parameter Parameter) bool

+ func (s Setting) Display() (string, bool)

+ type Settings []*Setting

+ func (s Settings) Apply(parameter Parameter, value any) error

+ func (s Settings) External() []string

+ func (s Settings) Map(options map[Parameter]any, ignore ...error) error

+ type Source uint8

+ func (s Source) Contains(source Source) bool

+ func (s Source) String() string

+ type Type interface

+ type Value struct

+ Description string

+ Name string

+ Ptr any

+ Source Source

+ func NewValue(name string, ptr *T, value T, source Source, description string) *Value

+ func (v *Value) Assign(value any, source Source) error

+ func (v *Value) Validate() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL