encoding

Documentation

Index

• func Encode(value Encodable) ([]byte, error)
• func EncodeToNode(encodable Encodable) (datamodel.Node, error)
• type Decoder
  • func NewDecoder(decodeType Encodable) (Decoder, error)
• type Encodable

Functions

func Encode

func Encode(value Encodable) ([]byte, error)

Encode encodes an encodable to CBOR, using the best available path for writing to CBOR

func EncodeToNode

func EncodeToNode(encodable Encodable) (datamodel.Node, error)

Types

type Decoder

type Decoder interface {
	DecodeFromCbor([]byte) (Encodable, error)
	DecodeFromNode(datamodel.Node) (Encodable, error)
}

Decoder is CBOR decoder for a given encodable type

func NewDecoder

func NewDecoder(decodeType Encodable) (Decoder, error)

NewDecoder creates a new Decoder that will decode into new instances of the given object type. It will use the decoding that is optimal for that type It returns error if it's not possible to setup a decoder for this type

type Encodable

type Encodable interface{}

Encodable is an object that can be written to CBOR and decoded back