encoding

Documentation

Index

• Variables
• type Encoding
  • func (e Encoding) GetHealth() (Serializer, error)
  • func (e Encoding) String() string
  • func (e *Encoding) UnmarshalFlag(s string) error
  • func (e *Encoding) UnmarshalText(text []byte) error
• type Serializer
  • func NewJSON(methodName string) Serializer
  • func NewProtobuf(fullMethodName string, source protobuf.DescriptorProvider) (Serializer, error)
  • func NewRaw(methodName string) Serializer
  • func NewThrift(thriftFile, methodName string, multiplexed bool) (Serializer, error)

Variables

var (

	// ErrHealthThriftOnly is returned if the user specifies an unsupported encoding with --health.
	ErrHealthThriftOnly = errors.New("--health can only be used with Thrift")
)

var (
	// ErrSpecifyThriftFile is returned if no Thrift file is specified
	// for a Thrift request.
	ErrSpecifyThriftFile = errors.New("specify a Thrift file using --thrift")
)

Types

type Encoding

type Encoding string

Encoding is the representation of the data on the wire.

const (
	UnspecifiedEncoding Encoding = ""
	JSON                Encoding = "json"
	Thrift              Encoding = "thrift"
	Raw                 Encoding = "raw"
	Protobuf            Encoding = "proto"
)

The list of supported encodings.

func (Encoding) GetHealth

func (e Encoding) GetHealth() (Serializer, error)

GetHealth returns a serializer for the Health endpoint.

func (Encoding) String

func (e Encoding) String() string

func (*Encoding) UnmarshalFlag

func (e *Encoding) UnmarshalFlag(s string) error

UnmarshalFlag allows Encoding to be used as a flag.

func (*Encoding) UnmarshalText

func (e *Encoding) UnmarshalText(text []byte) error

UnmarshalText imlements the encoding.TextUnmarshaler interface used by JSON, YAML, etc.

type Serializer

type Serializer interface {
	// Encoding returns the encoding for this serializer.
	Encoding() Encoding

	// Request creates a transport.Request from the given []byte input.
	Request(body []byte) (*transport.Request, error)

	// Response converts a transport.Response into something that can be displayed to a user.
	// For non-raw encodings, this is typically a map[string]interface{}.
	Response(body *transport.Response) (response interface{}, err error)

	// CheckSuccess checks whether the response body is a success, and if not, returns an
	// error with the failure reason.
	CheckSuccess(body *transport.Response) error
}

Serializer serializes and deserializes data for a specific encoding and method.

func NewJSON

func NewJSON(methodName string) Serializer

NewJSON returns a JSON serializer.

func NewProtobuf

func NewProtobuf(fullMethodName string, source protobuf.DescriptorProvider) (Serializer, error)

NewProtobuf returns a protobuf serializer.

func NewRaw

func NewRaw(methodName string) Serializer

NewRaw returns a raw serializer.

func NewThrift

func NewThrift(thriftFile, methodName string, multiplexed bool) (Serializer, error)

NewThrift returns a Thrift serializer.