shell

package

Go to main page

Versions in this module

v0

v0.10.1

Feb 18, 2023

v0.10.0

Dec 2, 2021

v0.9.1

Nov 28, 2021

v0.9.0

Nov 28, 2021

Changes in this version

type Option

+ func OptionExitOnError(exitOnError bool) Option

v0.8.0

Nov 28, 2021

Changes in this version

type Option

+ func OptionHelpHandler(handler Handler) Option

v0.7.0

Nov 27, 2021

Changes in this version

type Router

+ Mount func(string, Router)

+ type StandardRouter struct

+ func (rtr *StandardRouter) Define(fd flags.FlagDefiner)

+ func (rtr *StandardRouter) Execute(writer ResponseWriter, request *Request) error

+ func (rtr *StandardRouter) Flags(fn flags.FlagHandler)

+ func (rtr *StandardRouter) Group(setup func(r Router)) Router

+ func (rtr *StandardRouter) Handle(command string, handler Handler)

+ func (rtr *StandardRouter) HandleFunction(command string, handerFunction HandlerFunction)

+ func (rtr *StandardRouter) Match(args []string) (Handler, bool)

+ func (rtr *StandardRouter) Middlewares() []Middleware

+ func (rtr *StandardRouter) Mount(command string, router Router)

+ func (rtr *StandardRouter) NotFound(handler Handler)

+ func (rtr *StandardRouter) Route(command string, setup func(r Router)) Router

+ func (rtr *StandardRouter) Routes() map[string]Handler

+ func (rtr *StandardRouter) Use(middleware ...Middleware)

v0.6.0

Nov 19, 2021

Changes in this version

type ResponseWriter

+ Close func() error

type WrapperWriter

+ func (writer *WrapperWriter) Close() error

v0.5.0

Nov 19, 2021

v0.4.1

Nov 18, 2021

Changes in this version

+ var ErrHelp error = flag.ErrHelp

+ type DefaultFlagSet struct

+ func NewDefaultFlagSet() *DefaultFlagSet

+ func NewDefaultFlagSetWithBase(flagSet *flag.FlagSet) *DefaultFlagSet

+ func (flagSet *DefaultFlagSet) Bool(name string, defaultValue bool, usage string)

+ func (flagSet *DefaultFlagSet) Duration(name string, defaultValue time.Duration, usage string)

+ func (flagSet *DefaultFlagSet) Float(name string, defaultValue float64, usage string)

+ func (flagSet *DefaultFlagSet) Get(name string) interface{}

+ func (flagSet *DefaultFlagSet) GetBool(name string) *bool

+ func (flagSet *DefaultFlagSet) GetDuration(name string) *time.Duration

+ func (flagSet *DefaultFlagSet) GetFloat(name string) *float64

+ func (flagSet *DefaultFlagSet) GetInt(name string) *int64

+ func (flagSet *DefaultFlagSet) GetString(name string) *string

+ func (flagSet *DefaultFlagSet) GetUint(name string) *uint64

+ func (flagSet *DefaultFlagSet) Int(name string, defaultValue int64, usage string)

+ func (flagSet *DefaultFlagSet) Parse(args []string) ([]string, error)

+ func (flagSet *DefaultFlagSet) Parsed() bool

+ func (flagSet *DefaultFlagSet) Set(name, value string) error

+ func (flagSet *DefaultFlagSet) String(name string, defaultValue string, usage string)

+ func (flagSet *DefaultFlagSet) SubFlagSet(name string) FlagSet

+ func (flagSet *DefaultFlagSet) Uint(name string, defaultValue uint64, usage string)

+ type FlagDefiner interface

+ Bool func(name string, defaultValue bool, usage string)

+ Duration func(name string, defaultValue time.Duration, usage string)

+ Float func(name string, defaultValue float64, usage string)

+ Int func(name string, defaultValue int64, usage string)

+ String func(name string, defaultValue string, usage string)

+ Uint func(name string, defaultValue uint64, usage string)

+ type FlagHandler interface

+ Define func(FlagDefiner)

+ type FlagHandlerFunction func(FlagDefiner)

+ func (handler FlagHandlerFunction) Define(flagDefiner FlagDefiner)

+ type FlagSet interface

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

+ Parsed func() bool

+ SubFlagSet func(name string) FlagSet

+ type FlagValues interface

+ Get func(name string) interface{}

+ GetBool func(name string) *bool

+ GetDuration func(name string) *time.Duration

+ GetFloat func(name string) *float64

+ GetInt func(name string) *int64

+ GetString func(name string) *string

+ GetUint func(name string) *uint64

+ Set func(name, value string) error

+ type Handler interface

+ Execute func(ResponseWriter, *Request) error

+ type HandlerFunction func(ResponseWriter, *Request) error

+ func (fn HandlerFunction) Execute(writer ResponseWriter, request *Request) error

+ type Middleware interface

+ Handle func(next Handler) Handler

+ type MiddlewareFunction func(next Handler) Handler

+ func (middleware MiddlewareFunction) Handle(next Handler) Handler

+ type Option interface

+ Apply func(shell *Shell) error

+ func OptionErrorWriter(writer io.Writer) Option

+ func OptionFlagSet(flagSet FlagSet) Option

+ func OptionInput(reader io.Reader) Option

+ func OptionOutputWriter(writer io.Writer) Option

+ func OptionShellPrompt(prompt string) Option

+ type OptionFunction func(shell *Shell) error

+ func (option OptionFunction) Apply(shell *Shell) error

+ type Request struct

+ Args []string

+ FlagSet FlagSet

+ Path []string

+ Routes Routes

+ func NewRequest(path, args []string, flagSet FlagSet, routes Routes) *Request

+ func NewRequestWithContext(ctx context.Context, path, args []string, flagSet FlagSet, routes Routes) *Request

+ func (request *Request) Context() context.Context

+ func (request *Request) FlagValues() FlagValues

+ func (request *Request) UpdateRequest(selectedRoute string, args []string, flagSet FlagSet, routes Routes) *Request

+ func (request *Request) WithContext(ctx context.Context) *Request

+ type ResponseWriter interface

+ ErrorWriter func() io.Writer

+ Write func([]byte) (int, error)

+ WriteError func([]byte) (int, error)

+ type Router interface

+ Flags func(FlagHandler)

+ Group func(func(r Router)) Router

+ Handle func(string, Handler)

+ HandleFunction func(string, HandlerFunction)

+ NotFound func(Handler)

+ Route func(string, func(r Router)) Router

+ Use func(...Middleware)

+ type Routes interface

+ Match func([]string) (Handler, bool)

+ Middlewares func() []Middleware

+ Routes func() map[string]Handler

+ type Shell struct

+ func (shell *Shell) Closed() chan struct{}

+ func (shell *Shell) Execute(ctx context.Context) error

+ func (shell *Shell) Flags(fn FlagHandler)

+ func (shell *Shell) Group(fn func(r Router)) Router

+ func (shell *Shell) Handle(command string, handler Handler)

+ func (shell *Shell) HandleFunction(command string, fn HandlerFunction)

+ func (shell *Shell) NotFound(handler Handler)

+ func (shell *Shell) Options(options ...Option) error

+ func (shell *Shell) Route(command string, fn func(r Router)) Router

+ func (shell *Shell) Start(ctx context.Context) error

+ func (shell *Shell) Use(middleware ...Middleware)

+ type WrapperWriter struct

+ func NewWrapperWriter(ctx context.Context, outputWritter io.Writer, errorWriter io.Writer) *WrapperWriter

+ func (writer *WrapperWriter) ErrorWriter() io.Writer

+ func (writer *WrapperWriter) Write(bytes []byte) (int, error)

+ func (writer *WrapperWriter) WriteError(bytes []byte) (int, error)

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