source

Documentation

Index

• Variables
• type EnvOption
  • func EnvSplitter(splitter string) EnvOption
• type FileCodec
• type FileOption
  • func FileFormat(codec FileCodec) FileOption
  • func FilePathFlag(name string) FileOption
• type FlagOption
  • func FlagSplitter(splitter string) FlagOption
• type FlagSet
• type JSON
  • func (JSON) Decode(path string, v any) error
  • func (JSON) Encode(path string, v any) error
  • func (JSON) ExtName() string
  • func (JSON) TagName() string
• type Source
  • func Env(options ...EnvOption) Source
  • func File(options ...FileOption) Source
  • func Flag(opt ...FlagOption) Source

Variables

var ErrQuitEarly = errors.New("quit early")

Types

type EnvOption

type EnvOption func(*envSource) error

func EnvSplitter

func EnvSplitter(splitter string) EnvOption

type FileCodec

type FileCodec interface {
	TagName() string
	ExtName() string
	Encode(path string, v any) error
	Decode(path string, v any) error
}

type FileOption

type FileOption func(*fileSource) error

func FileFormat

func FileFormat(codec FileCodec) FileOption

func FilePathFlag

func FilePathFlag(name string) FileOption

type FlagOption

type FlagOption func(*flagSource) error

func FlagSplitter

func FlagSplitter(splitter string) FlagOption

type FlagSet

type FlagSet interface {
	PrintDefaults()
	Parse([]string) error
	Parsed() bool

	TextVar(p encoding.TextUnmarshaler, name string, value encoding.TextMarshaler, usage string)
	StringVar(v *string, name string, defaultValue string, usage string)
	BoolVar(v *bool, name string, defaultValue bool, usage string)
}

type JSON

type JSON struct{}

func (JSON) Decode

func (JSON) Decode(path string, v any) error

func (JSON) Encode

func (JSON) Encode(path string, v any) error

func (JSON) ExtName

func (JSON) ExtName() string

func (JSON) TagName

func (JSON) TagName() string

type Source

type Source interface {
	Register(fset FlagSet, fields []structtags.Field) error
	Parse(ctx context.Context, args []string) error
	Error() error
}

func Env

func Env(options ...EnvOption) Source

func File

func File(options ...FileOption) Source

func Flag

func Flag(opt ...FlagOption) Source