cmds

Aug 22, 2018

Changes in this version

+ var ErrRcvdError = fmt.Errorf("received command error")

+ func HandleError(err error, res Response, re ResponseEmitter) bool

+ type EncodingEmitter interface

+ SetEncoder func(func(io.Writer) Encoder)

+ type Head struct

+ Err *cmdkit.Error

+ Len uint64

+ func (h Head) Error() *cmdkit.Error

+ func (h Head) Length() uint64

+ type Header interface

+ Head func() Head

type Response

+ RawNext func() (interface{}, error)

type ResponseEmitter

+ SetError func(err interface{}, code cmdkit.ErrorType)

+ type WriterResponseEmitter struct

+ func (re *WriterResponseEmitter) Close() error

+ func (re *WriterResponseEmitter) Emit(v interface{}) error

+ func (re *WriterResponseEmitter) Head() Head

+ func (re *WriterResponseEmitter) SetEncoder(mkEnc func(io.Writer) Encoder)

+ func (re *WriterResponseEmitter) SetError(v interface{}, errType cmdkit.ErrorType)

+ func (re *WriterResponseEmitter) SetLength(length uint64)

Mar 22, 2022

Changes in this version

type Command

+ Status Status

+ type Status int

+ const Active

+ const Deprecated

+ const Experimental

+ const Removed

Jan 27, 2021

Changes in this version

type Option

+ func DelimitedStringsOption(delimiter string, names ...string) Option

Aug 4, 2020

Changes in this version

type Command

+ Extra *Extra

+ NoLocal bool

+ NoRemote bool

+ type Extra struct

+ func (e *Extra) GetValue(key interface{}) (interface{}, bool)

+ func (e *Extra) SetValue(key, value interface{}) *Extra

Mar 18, 2020

Changes in this version

+ const Ignore

+ const IgnoreRules

+ const Strings

+ var OptionIgnore = StringsOption(Ignore, ...)

+ var OptionIgnoreRules = StringOption(IgnoreRules, ...)

type Option

+ func StringsOption(names ...string) Option

Jun 28, 2019

Changes in this version

type Error

+ func (e Error) Unwrap() error

type ErrorType

+ func (e ErrorType) Error() string

+ func (e ErrorType) String() string

Jun 11, 2019

Changes in this version

type ErrorType

+ const ErrForbidden

+ const ErrRateLimited

May 11, 2019

Changes in this version

+ const Bool

+ const Float

+ const Int

+ const Int64

+ const Invalid

+ const String

+ const Uint

+ const Uint64

+ type Argument struct

+ Description string

+ Name string

+ Recursive bool

+ Required bool

+ SupportsStdin bool

+ Type ArgumentType

+ Variadic bool

+ func FileArg(name string, required, variadic bool, description string) Argument

+ func StringArg(name string, required, variadic bool, description string) Argument

+ func (a Argument) EnableRecursive() Argument

+ func (a Argument) EnableStdin() Argument

+ type ArgumentType int

+ const ArgFile

+ const ArgString

+ type Error struct

+ Code ErrorType

+ Message string

+ func Errorf(code ErrorType, format string, args ...interface{}) Error

+ func (e *Error) UnmarshalJSON(data []byte) error

+ func (e Error) Error() string

+ func (e Error) MarshalJSON() ([]byte, error)

+ type ErrorType uint

+ const ErrClient

+ const ErrFatal

+ const ErrImplementation

+ const ErrNormal

+ const ErrNotFound

+ type HelpText struct

+ Arguments string

+ LongDescription string

+ Options string

+ ShortDescription string

+ Subcommands string

+ Synopsis string

+ SynopsisOptionsValues map[string]string

+ Tagline string

+ Usage string

+ type OptMap map[string]interface

+ type Option interface

+ Default func() interface{}

+ Description func() string

+ Name func() string

+ Names func() []string

+ Parse func(str string) (interface{}, error)

+ Type func() reflect.Kind

+ WithDefault func(interface{}) Option

+ func BoolOption(names ...string) Option

+ func FloatOption(names ...string) Option

+ func Int64Option(names ...string) Option

+ func IntOption(names ...string) Option

+ func NewOption(kind reflect.Kind, names ...string) Option

+ func StringOption(names ...string) Option

+ func Uint64Option(names ...string) Option

+ func UintOption(names ...string) Option

Mar 22, 2019

Changes in this version

+ const Hidden

+ const HiddenShort

+ const StdinName

+ var OptionHidden = cmdkit.BoolOption(Hidden, HiddenShort, ...)

+ var OptionStdinName = cmdkit.StringOption(StdinName, "Assign a name if the file source is stdin.")

Mar 2, 2019

Changes in this version

+ const CLI

+ const ChanOpt

+ const DefaultOutputEncoding

+ const DerefLong

+ const EncLong

+ const EncShort

+ const JSON

+ const OptLongHelp

+ const OptShortHelp

+ const Protobuf

+ const RecLong

+ const RecShort

+ const Text

+ const TextNewline

+ const TimeoutOpt

+ const Undefined

+ const XML

+ var Decoders = map[EncodingType]func(w io.Reader) Decoder

+ var Encoders = EncoderMap

+ var ErrClosedEmitter = errors.New("cmds: emit on closed emitter")

+ var ErrClosingClosedEmitter = errors.New("cmds: closing closed emitter")

+ var ErrIncorrectType = errors.New("The command returned a value with a different type than expected")

+ var ErrNoFormatter = ClientError("This command cannot be formatted to plain text")

+ var ErrNotCallable = ClientError("This command can't be called directly. Try one of its subcommands.")

+ var OptionDerefArgs = cmdkit.BoolOption(DerefLong, "Symlinks supplied in arguments are dereferenced")

+ var OptionEncodingType = cmdkit.StringOption(EncLong, EncShort, "The encoding type the output should be encoded with (json, xml, or text)").WithDefault("text")

+ var OptionRecursivePath = cmdkit.BoolOption(RecLong, RecShort, "Add directory paths recursively")

+ var OptionStreamChannels = cmdkit.BoolOption(ChanOpt, "Stream channel output")

+ var OptionTimeout = cmdkit.StringOption(TimeoutOpt, "Set a global timeout on the command")

+ func ClientError(msg string) error

+ func Copy(re ResponseEmitter, res Response) error

+ func EmitChan(re ResponseEmitter, ch <-chan interface{}) error

+ func EmitOnce(re ResponseEmitter, v interface{}) error

+ func GetEncoder(req *Request, w io.Writer, def EncodingType) (encType EncodingType, enc Encoder, err error)

+ func MakeEncoder(f func(*Request, io.Writer, interface{}) error) func(*Request) func(io.Writer) Encoder

+ func MakeTypedEncoder(f interface{}) func(*Request) func(io.Writer) Encoder

+ func NewChanResponsePair(req *Request) (ResponseEmitter, Response)

+ type Command struct

+ Arguments []cmdkit.Argument

+ Encoders EncoderMap

+ External bool

+ Helptext cmdkit.HelpText

+ Options []cmdkit.Option

+ PostRun PostRunMap

+ PreRun func(req *Request, env Environment) error

+ Run Function

+ Subcommands map[string]*Command

+ Type interface{}

+ func (c *Command) Call(req *Request, re ResponseEmitter, env Environment)

+ func (c *Command) CheckArguments(req *Request) error

+ func (c *Command) DebugValidate() map[string][]error

+ func (c *Command) Get(path []string) (*Command, error)

+ func (c *Command) GetOptions(path []string) (map[string]cmdkit.Option, error)

+ func (c *Command) ProcessHelp()

+ func (c *Command) Resolve(pth []string) ([]*Command, error)

+ func (c *Command) Walk(visitor CommandVisitor)

+ type CommandVisitor func(*Command)

+ type Decoder interface

+ Decode func(value interface{}) error

+ type Encoder interface

+ Encode func(value interface{}) error

+ type EncoderFunc func(req *Request) func(w io.Writer) Encoder

+ type EncoderMap map[EncodingType]EncoderFunc

+ type EncodingType string

+ func GetEncoding(req *Request, def EncodingType) EncodingType

+ type Environment interface

+ Context func() context.Context

+ type Executor interface

+ Execute func(req *Request, re ResponseEmitter, env Environment) error

+ func NewExecutor(root *Command) Executor

+ type Flusher interface

+ Flush func() error

+ type Function func(*Request, ResponseEmitter, Environment) error

+ type MakeEnvironment func(context.Context, *Request) (Environment, error)

+ type MakeExecutor func(*Request, interface{}) (Executor, error)

+ type MaybeError struct

+ Error *cmdkit.Error

+ Value interface{}

+ func (m *MaybeError) Get() (interface{}, error)

+ func (m *MaybeError) UnmarshalJSON(data []byte) error

+ type PostRunMap map[PostRunType]func(Response, ResponseEmitter) error

+ type PostRunType string

+ type ReqLog struct

+ Requests []*ReqLogEntry

+ func (rl *ReqLog) Add(req *Request) *ReqLogEntry

+ func (rl *ReqLog) AddEntry(rle *ReqLogEntry)

+ func (rl *ReqLog) ClearInactive()

+ func (rl *ReqLog) Finish(rle *ReqLogEntry)

+ func (rl *ReqLog) Report() []*ReqLogEntry

+ func (rl *ReqLog) SetKeepTime(t time.Duration)

+ type ReqLogEntry struct

+ Active bool

+ Args []string

+ Command string

+ EndTime time.Time

+ ID int

+ Options map[string]interface{}

+ StartTime time.Time

+ func (r *ReqLogEntry) Copy() *ReqLogEntry

+ type Request struct

+ Arguments []string

+ Command *Command

+ Context context.Context

+ Files files.Directory

+ Options cmdkit.OptMap

+ Path []string

+ Root *Command

+ func NewRequest(ctx context.Context, path []string, opts cmdkit.OptMap, args []string, ...) (*Request, error)

+ func (req *Request) BodyArgs() StdinArguments

+ func (req *Request) FillDefaults() error

+ func (req *Request) ParseBodyArgs() error

+ func (req *Request) SetOption(name string, value interface{})

+ type Response interface

+ Error func() *cmdkit.Error

+ Length func() uint64

+ Next func() (interface{}, error)

+ Request func() *Request

+ func NewReaderResponse(r io.Reader, req *Request) (Response, error)

+ type ResponseEmitter interface

+ Close func() error

+ CloseWithError func(error) error

+ Emit func(value interface{}) error

+ SetLength func(length uint64)

+ func NewFlushForwarder(re ResponseEmitter, f Flusher) ResponseEmitter

+ func NewWriterResponseEmitter(w io.WriteCloser, req *Request) (ResponseEmitter, error)

+ type Single struct

+ Value interface{}

+ func (s Single) GoString() string

+ func (s Single) String() string

+ type StdinArguments interface

+ Argument func() string

+ Err func() error

+ Scan func() bool

+ type TextEncoder struct

+ func (e TextEncoder) Encode(v interface{}) error