codec

Documentation

Index

• Variables
• func Marshal(v interface{}) (string, []byte, error)
• func Register(v interface{}) error
• func TypeName(v interface{}) string
• func Unmarshal(buf []byte, name string) (interface{}, error)

Variables

var (
	// ErrUnsupportedMessage when register is called with a type
	// which cannot be en/decoded by the codec.
	ErrUnsupportedMessage = errors.New("codec: unsupported message")
	// ErrUnregisteredMessageType when a unregistered type is called
	// for marshalling or unmarshalling.
	ErrUnregisteredMessageType = errors.New("codec: unregistered message type")
)

Functions

func Marshal

func Marshal(v interface{}) (string, []byte, error)

Marshal the value into bytes. The function returns the type name, the bytes, or an error.

func Register

func Register(v interface{}) error

Register a type for marshalling and unmarshalling. The type must currently implement proto.Message.

func TypeName

func TypeName(v interface{}) string

TypeName of a value. This name is used in the registry to distinguish types.

func Unmarshal

func Unmarshal(buf []byte, name string) (interface{}, error)

Unmarshal the bytes into a value whos type is given, or return an error.