serializer

Documentation

Index

• Variables
• type ContentType
  • func (c ContentType) String() string
• type Object
• type Serialization
  • func (s *Serialization) Decode(data []byte, obj Object) error
  • func (s *Serialization) DecodeFromStream(r io.Reader, obj Object) error
  • func (s *Serialization) Encode(obj Object) ([]byte, error)
  • func (s *Serialization) EncodeToStream(w io.Writer, obj Object) error
• type Serializer
  • func NewSerializer() Serializer

Variables

var Codec = NewSerializer()

Codec is an instance of Serializer.

Types

type ContentType

type ContentType string

ContentType is a defined type.

const (
	// ContentTypeJSON is a json ContentType.
	ContentTypeJSON ContentType = "application/json"
)

func (ContentType) String

func (c ContentType) String() string

String return ContentType as string type.

type Object

type Object interface{}

Object is an interface to define object.

type Serialization

type Serialization struct {
}

Serialization is the default implement of interface Serializer.

func (*Serialization) Decode

func (s *Serialization) Decode(data []byte, obj Object) error

Decode is used to decode obj from date.

func (*Serialization) DecodeFromStream

func (s *Serialization) DecodeFromStream(r io.Reader, obj Object) error

DecodeFromStream is used to decode obj from stream.

func (*Serialization) Encode

func (s *Serialization) Encode(obj Object) ([]byte, error)

Encode is used to encode obj.

func (*Serialization) EncodeToStream

func (s *Serialization) EncodeToStream(w io.Writer, obj Object) error

EncodeToStream is used to encode obj to stream.

type Serializer

type Serializer interface {
	Encode(obj Object) ([]byte, error)
	Decode(data []byte, obj Object) error
	EncodeToStream(w io.Writer, obj Object) error
	DecodeFromStream(r io.Reader, obj Object) error
}

Serializer is an interface generalizes object serialize operation.

func NewSerializer

func NewSerializer() Serializer

NewSerializer returns Serializer instance.