commands

Mar 1, 2019

Changes in this version

type Context

+ Gateway bool

+ Plugins *loader.PluginLoader

+ func (c *Context) GetAPI() (coreiface.CoreAPI, error)

Nov 2, 2018

Changes in this version

type Context

+ func (c *Context) GetApi() (coreiface.CoreAPI, error)

Mar 23, 2018

Changes in this version

type Context

+ func (c *Context) Close()

+ func (c *Context) LogRequest(req *cmds.Request) func()

type ReqLog

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

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

Mar 30, 2017

Changes in this version

type ErrorType

+ const ErrNotFound

Sep 20, 2016

Changes in this version

+ const Protobuf

type HelpText

+ SynopsisOptionsValues map[string]string

type Request

+ StringArguments func() []string

+ VarArgs func(func(string) error) error

May 17, 2016

Changes in this version

type Command

+ func (c *Command) ProcessHelp()

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

+ type CommandVisitor func(*Command)

Apr 7, 2016

Changes in this version

type Context

+ ReqLog *ReqLog

type Option

+ Default func(interface{}) Option

+ DefaultVal func() interface{}

+ type ReqLog struct

+ Requests []*ReqLogEntry

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

+ func (rl *ReqLog) ClearInactive()

+ 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

+ func (r *ReqLogEntry) Finish()

Dec 8, 2015

Changes in this version

type Command

+ External bool

Oct 19, 2015

Changes in this version

type ChannelMarshaler

+ Res Response

Jul 30, 2015

Changes in this version

+ const TimeoutOpt

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

type ErrorType

+ const ErrImplementation

type Request

+ InvocContext func() *Context

+ SetInvocContext func(Context)

+ SetRootContext func(context.Context) error

type Response

+ Close func() error

+ SetCloser func(io.Closer)

Apr 22, 2015

Changes in this version

+ type OptMap map[string]interface

Feb 27, 2015

Changes in this version

+ const Bool

+ const ChanOpt

+ const EncLong

+ const EncShort

+ const Float

+ const Int

+ const Invalid

+ const JSON

+ const RecLong

+ const RecShort

+ const String

+ const Text

+ const Uint

+ const XML

+ 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 OptionEncodingType = StringOption(EncShort, EncLong, ...)

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

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

+ func ClientError(msg string) error

+ 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 ChannelMarshaler struct

+ Channel <-chan interface{}

+ Marshaler func(interface{}) (io.Reader, error)

+ func (cr *ChannelMarshaler) Read(p []byte) (int, error)

+ type Command struct

+ Arguments []Argument

+ Helptext HelpText

+ Marshalers map[EncodingType]Marshaler

+ Options []Option

+ PostRun Function

+ PreRun func(req Request) error

+ Run Function

+ Subcommands map[string]*Command

+ Type interface{}

+ func (c *Command) Call(req Request) Response

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

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

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

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

+ func (c *Command) Subcommand(id string) *Command

+ type Context struct

+ ConfigRoot string

+ ConstructNode func() (*core.IpfsNode, error)

+ Context context.Context

+ LoadConfig func(path string) (*config.Config, error)

+ Online bool

+ func (c *Context) GetConfig() (*config.Config, error)

+ func (c *Context) GetNode() (*core.IpfsNode, error)

+ func (c *Context) NodeWithoutConstructing() *core.IpfsNode

+ type EncodingType string

+ type Error struct

+ Code ErrorType

+ Message string

+ func (e Error) Error() string

+ type ErrorType uint

+ const ErrClient

+ const ErrNormal

+ type Function func(Request, Response)

+ type HelpText struct

+ Arguments string

+ LongDescription string

+ Options string

+ ShortDescription string

+ Subcommands string

+ Synopsis string

+ Tagline string

+ Usage string

+ type Marshaler func(Response) (io.Reader, error)

+ type MarshalerMap map[EncodingType]Marshaler

+ type Option interface

+ Description func() string

+ Names func() []string

+ Type func() reflect.Kind

+ func BoolOption(names ...string) Option

+ func FloatOption(names ...string) Option

+ func IntOption(names ...string) Option

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

+ func StringOption(names ...string) Option

+ func UintOption(names ...string) Option

+ type OptionValue struct

+ func (ov OptionValue) Bool() (value bool, found bool, err error)

+ func (ov OptionValue) Definition() Option

+ func (ov OptionValue) Float() (value float64, found bool, err error)

+ func (ov OptionValue) Found() bool

+ func (ov OptionValue) Int() (value int, found bool, err error)

+ func (ov OptionValue) String() (value string, found bool, err error)

+ func (ov OptionValue) Uint() (value uint, found bool, err error)

+ type Request interface

+ Arguments func() []string

+ Command func() *Command

+ Context func() *Context

+ ConvertOptions func() error

+ Files func() files.File

+ Option func(name string) *OptionValue

+ Options func() optMap

+ Path func() []string

+ SetArguments func([]string)

+ SetContext func(Context)

+ SetFiles func(files.File)

+ SetOption func(name string, val interface{})

+ SetOptions func(opts map[string]interface{}) error

+ Stdin func() io.Reader

+ Values func() map[string]interface{}

+ func NewEmptyRequest() (Request, error)

+ func NewRequest(path []string, opts optMap, args []string, file files.File, cmd *Command, ...) (Request, error)

+ type Response interface

+ Error func() *Error

+ Length func() uint64

+ Marshal func() (io.Reader, error)

+ Output func() interface{}

+ Reader func() (io.Reader, error)

+ Request func() Request

+ SetError func(err error, code ErrorType)

+ SetLength func(uint64)

+ SetOutput func(interface{})

+ Stderr func() io.Writer

+ Stdout func() io.Writer

+ func NewResponse(req Request) Response