flargs

May 5, 2024

Changes in this version

type Environment

+ RandSource rand.Source

May 1, 2024

Changes in this version

+ func Pipe(f1 Command, f2 Command) (int64, error)

type Command

+ func (k Command) LoadAndRun() error

+ func (k Command) ParseAndLoad(args []string) error

type Environment

+ func NewNullEnvironment() *Environment

type ExitCode

+ func (ec ExitCode) Error() string

type FlargError

+ UnderlyingError error

type Flarger

+ Run func(*Environment) error

+ type NullDevice struct

+ func (b NullDevice) Open(_ string) (fs.File, error)

+ func (b NullDevice) Read(_ []byte) (int, error)

+ type Phase uint8

+ const Loading

+ const Parsing

+ const Ran

+ const Running

+ const Uninitialized

+ type StateMachine struct

+ Phase Phase

+ RemainingArgs []string

+ func (s *StateMachine) Load(_ *Environment) error

+ func (s *StateMachine) Parse(a []string) error

+ func (s *StateMachine) Run(_ *Environment) error

Apr 27, 2024

Changes in this version

type Command

+ func (com Command[T]) Load(conf T) error

type Environment

+ Filesystem fs.FS

+ type Flarger interface

+ Load func(*Environment) error

+ Parse func([]string) ([]string, error)

+ var AnyFlarger Flarger[any]

+ func NewFlarger[T Flarger[T]](pFunc ParseFunc[T], lFunc LoadFunc[T], konfig T) Flarger[T]

+ type LoadFunc func(*Environment) error

Apr 20, 2024

Changes in this version

+ const ExitCodeCannotExecute

+ const ExitCodeCommandNotFound

+ const ExitCodeFatalErrorSignal1

+ const ExitCodeFatalErrorSignal2

+ const ExitCodeFatalErrorSignal3

+ const ExitCodeFatalErrorSignal4

+ const ExitCodeFatalErrorSignal5

+ const ExitCodeFatalErrorSignal6

+ const ExitCodeFatalErrorSignal7

+ const ExitCodeFatalErrorSignal8

+ const ExitCodeFatalErrorSignal9

+ const ExitCodeGenericError

+ const ExitCodeInvalidArgumentToExit

+ const ExitCodeMisuseOfBuiltIns

+ const ExitCodeSuccess

type Environment

+ func (e Environment) GetError() []byte

+ func (e Environment) GetInput() []byte

+ func (e Environment) GetOutput() []byte

+ type ExitCode uint8

Apr 16, 2024

Changes in this version

type Command

+ Env *Environment

+ func (com1 Command[T]) Pipe(conf1 T, env2 *Environment) error

+ type ParseFunc func([]string) (T, []string, error)

+ type RunFunc func(*Environment, T) error

Apr 7, 2024

Changes in this version

type Environment

+ Randomness io.Reader

Mar 30, 2024

Changes in this version

+ type Command interface

+ Run func(margs) error

+ func NewCommand(env *Environment, exe CommandFunction) Command

+ type CommandFunction func(*Environment, margs) error

+ type Environment struct

+ ErrorStream io.ReadWriter

+ InputStream io.Reader

+ OutputStream io.ReadWriter

+ Variables map[string]string

+ func NewCLIEnvironment() *Environment

+ func NewTestingEnvironment() *Environment

+ type FlargError struct

+ func NewFlargError(msg string, childError error) *FlargError

+ func (pe *FlargError) Error() string

+ func (pe *FlargError) Unwrap() error

+ type Flargs interface

+ Parse func([]string) (map[string]any, []string, error)

+ func NewFlargs(fn FlargsParseFunc) Flargs

+ type FlargsParseFunc func([]string) (map[string]any, []string, error)