cbor

Documentation

Index

• Variables
• type Codec
  • func NewCodec(opts ...Option) *Codec
  • func (c *Codec) NewDecoder(r io.Reader) encoding.Decoder
  • func (c *Codec) NewEncoder(w io.Writer) encoding.Encoder
• type Marshaler
  • func NewMarshaler() *Marshaler
  • func (m *Marshaler) Marshal(val interface{}) ([]byte, error)
  • func (m *Marshaler) MustMarshal(val interface{}) []byte
  • func (m *Marshaler) MustUnmarshal(b []byte, val interface{})
  • func (m *Marshaler) Unmarshal(b []byte, val interface{}) error
• type Option
  • func WithDecMode(decMode cbor.DecMode) Option
  • func WithEncMode(encMode cbor.EncMode) Option

Variables

var DecMode, _ = cbor.DecOptions{}.DecMode()

DecMode is the default DecMode to use when creating a new cbor Decoder

var EncMode = func() cbor.EncMode {

	options := cbor.CoreDetEncOptions()

	options.Time = cbor.TimeRFC3339Nano
	encMode, err := options.EncMode()
	if err != nil {
		panic(fmt.Errorf("could not extract encoding mode: %w", err))
	}
	return encMode
}()

EncMode is the default EncMode to use when creating a new cbor Encoder

Types

type Codec

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

func NewCodec

func NewCodec(opts ...Option) *Codec

NewCodec returns a new cbor Codec with the provided EncMode and DecMode. If either is nil, the default cbor EncMode/DecMode will be used.

func (*Codec) NewDecoder

func (c *Codec) NewDecoder(r io.Reader) encoding.Decoder

func (*Codec) NewEncoder

func (c *Codec) NewEncoder(w io.Writer) encoding.Encoder

type Marshaler

type Marshaler struct{}

func NewMarshaler

func NewMarshaler() *Marshaler

func (*Marshaler) Marshal

func (m *Marshaler) Marshal(val interface{}) ([]byte, error)

func (*Marshaler) MustMarshal

func (m *Marshaler) MustMarshal(val interface{}) []byte

func (*Marshaler) MustUnmarshal

func (m *Marshaler) MustUnmarshal(b []byte, val interface{})

func (*Marshaler) Unmarshal

func (m *Marshaler) Unmarshal(b []byte, val interface{}) error

type Option

type Option func(*Codec)

func WithDecMode

func WithDecMode(decMode cbor.DecMode) Option

WithDecMode sets the DecMode to use when creating a new cbor Decoder.

func WithEncMode

func WithEncMode(encMode cbor.EncMode) Option

WithEncMode sets the EncMode to use when creating a new cbor Encoder.