cbor

Documentation

Overview

Package implementing the CBOR -- Concise Binary Object Notation -- http://cbor.io/ -- spec.

CBOR is more or less freely interchangable with json: it's schemaless, and composed of similar map and array types. However, CBOR is binary, length delimited -- and thus very fast to parse, and can store binary data without expansion problems -- and also distinguishes types like integer, string, float, and bytes all clearly from each other.

The `cbor.Marshal` and `cbor.Unmarshal` functions are the quickest way to convert your Go objects to and from serial CBOR.

The `cbor.NewMarshaller` and `cbor.NewUmarshaller` functions give a little more control. If performance is important, prefer these; recycling the marshaller instances will significantly cut down on memory allocations and improve performance.

The `*Atlased` variants of constructors allow you set up marshalling with an `refmt/obj/atlas.Atlas`, unlocking all of refmt's advanced features and custom object mapping powertools.

The `cbor.Encoder` and `cbor.Decoder` types implement the low-level functionality of converting serial CBOR byte streams into refmt Token streams. Users don't usually need to use these directly.

Index

• func Marshal(v interface{}) ([]byte, error)
• func MarshalAtlased(v interface{}, atl atlas.Atlas) ([]byte, error)
• func Unmarshal(cfg DecodeOptions, data []byte, v interface{}) error
• func UnmarshalAtlased(cfg DecodeOptions, data []byte, v interface{}, atl atlas.Atlas) error
• type DecodeOptions
  • func (DecodeOptions) IsDecodeOptions()
• type Decoder
  • func NewDecoder(cfg DecodeOptions, r io.Reader) (d *Decoder)
  • func (d *Decoder) Reset()
  • func (d *Decoder) Step(tokenSlot *Token) (done bool, err error)
• type EncodeOptions
  • func (EncodeOptions) IsEncodeOptions()
• type Encoder
  • func NewEncoder(w io.Writer) (d *Encoder)
  • func (d *Encoder) Reset()
  • func (d *Encoder) Step(tokenSlot *Token) (done bool, err error)
• type ErrInvalidTokenStream
  • func (e *ErrInvalidTokenStream) Error() string
• type Marshaller
  • func NewMarshaller(wr io.Writer) *Marshaller
  • func NewMarshallerAtlased(wr io.Writer, atl atlas.Atlas) *Marshaller
  • func (x *Marshaller) Marshal(v interface{}) error
• type Unmarshaller
  • func NewUnmarshaller(cfg DecodeOptions, r io.Reader) *Unmarshaller
  • func NewUnmarshallerAtlased(cfg DecodeOptions, r io.Reader, atl atlas.Atlas) *Unmarshaller
  • func (x *Unmarshaller) Unmarshal(v interface{}) error

Functions

func Marshal

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

func MarshalAtlased

func MarshalAtlased(v interface{}, atl atlas.Atlas) ([]byte, error)

func Unmarshal

func Unmarshal(cfg DecodeOptions, data []byte, v interface{}) error

func UnmarshalAtlased

func UnmarshalAtlased(cfg DecodeOptions, data []byte, v interface{}, atl atlas.Atlas) error

Types

type DecodeOptions

type DecodeOptions struct {
	CoerceUndefToNull bool
}

func (DecodeOptions) IsDecodeOptions

func (DecodeOptions) IsDecodeOptions()

marker method -- you may use this type to instruct `refmt.Marshal` what kind of encoder to use.

type Decoder

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

func NewDecoder

func NewDecoder(cfg DecodeOptions, r io.Reader) (d *Decoder)

func (*Decoder) Reset

func (d *Decoder) Reset()

func (*Decoder) Step

func (d *Decoder) Step(tokenSlot *Token) (done bool, err error)

type EncodeOptions

type EncodeOptions struct {
}

func (EncodeOptions) IsEncodeOptions

func (EncodeOptions) IsEncodeOptions()

marker method -- you may use this type to instruct `refmt.Marshal` what kind of encoder to use.

type Encoder

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

func NewEncoder

func NewEncoder(w io.Writer) (d *Encoder)

func (*Encoder) Reset

func (d *Encoder) Reset()

func (*Encoder) Step

func (d *Encoder) Step(tokenSlot *Token) (done bool, err error)

type ErrInvalidTokenStream

type ErrInvalidTokenStream struct {
	Got        Token
	Acceptable []TokenType
}

Error raised by Encoder when invalid tokens or invalid ordering, e.g. a MapClose with no matching open. Should never be seen by the user in practice unless generating their own token streams.

func (*ErrInvalidTokenStream) Error

func (e *ErrInvalidTokenStream) Error() string

type Marshaller

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

func NewMarshaller

func NewMarshaller(wr io.Writer) *Marshaller

func NewMarshallerAtlased

func NewMarshallerAtlased(wr io.Writer, atl atlas.Atlas) *Marshaller

func (*Marshaller) Marshal

func (x *Marshaller) Marshal(v interface{}) error

type Unmarshaller

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

func NewUnmarshaller

func NewUnmarshaller(cfg DecodeOptions, r io.Reader) *Unmarshaller

func NewUnmarshallerAtlased

func NewUnmarshallerAtlased(cfg DecodeOptions, r io.Reader, atl atlas.Atlas) *Unmarshaller

func (*Unmarshaller) Unmarshal

func (x *Unmarshaller) Unmarshal(v interface{}) error