codec

Documentation

Index

• Variables
• type BinaryEncoder
• type ThriftObject
• type ThriftRWEncoder
  • func NewThriftRWEncoder() *ThriftRWEncoder
  • func (t *ThriftRWEncoder) Decode(b []byte, val ThriftObject) error
  • func (t *ThriftRWEncoder) Encode(obj ThriftObject) ([]byte, error)

Variables

var (
	// MissingBinaryEncodingVersion indicate that the encoding version is missing
	MissingBinaryEncodingVersion = &types.BadRequestError{Message: "Missing binary encoding version."}
	// InvalidBinaryEncodingVersion indicate that the encoding version is incorrect
	InvalidBinaryEncodingVersion = &types.BadRequestError{Message: "Invalid binary encoding version."}
	// MsgPayloadNotThriftEncoded indicate message is not thrift encoded
	MsgPayloadNotThriftEncoded = &types.BadRequestError{Message: "Message payload is not thrift encoded."}
)

Types

type BinaryEncoder

type BinaryEncoder interface {
	Encode(obj ThriftObject) ([]byte, error)
	Decode(payload []byte, val ThriftObject) error
}

BinaryEncoder represent the encoder which can serialize or deserialize object

type ThriftObject

type ThriftObject interface {
	FromWire(w wire.Value) error
	ToWire() (wire.Value, error)
	Encode(stream.Writer) error
	Decode(stream.Reader) error
}

ThriftObject represents a thrift object

type ThriftRWEncoder

type ThriftRWEncoder struct {
}

ThriftRWEncoder is an implementation using thrift rw for binary encoding / decoding NOTE: this encoder only works for thrift struct

func NewThriftRWEncoder

func NewThriftRWEncoder() *ThriftRWEncoder

NewThriftRWEncoder generate a new ThriftRWEncoder

func (*ThriftRWEncoder) Decode

func (t *ThriftRWEncoder) Decode(b []byte, val ThriftObject) error

Decode decode the object

func (*ThriftRWEncoder) Encode

func (t *ThriftRWEncoder) Encode(obj ThriftObject) ([]byte, error)

Encode encode the object