cmd

Documentation

Index

• type Request
  • func NewRequest(args []string) *Request
  • func (r *Request) Bind(i interface{}) error
  • func (*Request) Context() context.Context
  • func (*Request) HostName() (hostname string)
  • func (r *Request) Param(key string) string
  • func (r *Request) Params(key string) []string
  • func (r *Request) PathParam(key string) string
• type Responder
  • func (*Responder) Respond(data interface{}, err error)

Types

type Request

type Request struct {
	// contains filtered or unexported fields
}

Request is an abstraction over the actual command with flags. This abstraction is useful because it allows us to create cmd applications in same way we would create a HTTP server application. Gofr's http.Request is another such abstraction.

func NewRequest

func NewRequest(args []string) *Request

NewRequest creates a Request from a list of arguments. This way we can simulate running a command without actually doing it. It makes the code more testable this way.

func (*Request) Bind

func (r *Request) Bind(i interface{}) error

func (*Request) Context

func (*Request) Context() context.Context

func (*Request) HostName

func (*Request) HostName() (hostname string)

func (*Request) Param

func (r *Request) Param(key string) string

Param returns the value of the parameter for key.

func (*Request) Params

func (r *Request) Params(key string) []string

Params retrieves all values for a given query parameter key, including comma-separated values.

func (*Request) PathParam

func (r *Request) PathParam(key string) string

PathParam returns the value of the parameter for key. This is equivalent to Param.

type Responder

type Responder struct{}

func (*Responder) Respond

func (*Responder) Respond(data interface{}, err error)