cbor

Documentation

Index

• Constants
• func Decode(dataBytes []byte, dest interface{}) (int, error)
• func DecodeById(cborData []byte, idMap map[int]interface{}) (interface{}, error)
• func DecodeIdFromList(cborData []byte) (int, error)
• func Encode(data interface{}) ([]byte, error)
• func ListLength(cborData []byte) (int, error)
• type ByteString
  • func NewByteString(data []byte) ByteString
  • func (bs ByteString) Bytes() []byte
  • func (bs ByteString) String() string
  • func (bs *ByteString) UnmarshalCBOR(data []byte) error
• type DecodeStoreCbor
  • func (d *DecodeStoreCbor) Cbor() []byte
  • func (d *DecodeStoreCbor) UnmarshalCborGeneric(cborData []byte, dest DecodeStoreCborInterface) error
• type DecodeStoreCborInterface
• type RawMessage
• type StructAsArray
• type Value
  • func (v *Value) UnmarshalCBOR(data []byte) error

Constants

const (
	CBOR_TYPE_BYTE_STRING uint8 = 0x40
	CBOR_TYPE_TEXT_STRING uint8 = 0x60
	CBOR_TYPE_ARRAY       uint8 = 0x80
	CBOR_TYPE_MAP         uint8 = 0xa0

	// Only the top 3 bytes are used to specify the type
	CBOR_TYPE_MASK uint8 = 0xe0

	// Max value able to be stored in a single byte without type prefix
	CBOR_MAX_UINT_SIMPLE uint8 = 0x17
)

Functions

func Decode

func Decode(dataBytes []byte, dest interface{}) (int, error)

func DecodeById

func DecodeById(cborData []byte, idMap map[int]interface{}) (interface{}, error)

Decode CBOR list data by the leading value of each list item. It expects CBOR data and a map of numbers to object pointers to decode into

func DecodeIdFromList

func DecodeIdFromList(cborData []byte) (int, error)

Extract the first item from a CBOR list. This will return the first item from the provided list if it's numeric and an error otherwise

func Encode

func Encode(data interface{}) ([]byte, error)

func ListLength

func ListLength(cborData []byte) (int, error)

Determine the length of a CBOR list

Types

type ByteString

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

Wrapper for bytestrings that allows them to be used as keys for a map

func NewByteString

func NewByteString(data []byte) ByteString

func (ByteString) Bytes

func (bs ByteString) Bytes() []byte

func (ByteString) String

func (bs ByteString) String() string

func (*ByteString) UnmarshalCBOR

func (bs *ByteString) UnmarshalCBOR(data []byte) error

type DecodeStoreCbor

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

func (*DecodeStoreCbor) Cbor

func (d *DecodeStoreCbor) Cbor() []byte

Cbor returns the original CBOR for the object

func (*DecodeStoreCbor) UnmarshalCborGeneric

func (d *DecodeStoreCbor) UnmarshalCborGeneric(cborData []byte, dest DecodeStoreCborInterface) error

UnmarshalCborGeneric decodes the specified CBOR into the destination object without using the destination object's UnmarshalCBOR() function

type DecodeStoreCborInterface

type DecodeStoreCborInterface interface {
	Cbor() []byte
}

type RawMessage

type RawMessage = _cbor.RawMessage

Create an alias for RawMessage for convenience

type StructAsArray

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

Useful for embedding and easier to remember

type Value

type Value struct {
	Value interface{}
}

Helpful wrapper for parsing arbitrary CBOR data which may contain types that cannot be easily represented in Go (such as maps with bytestring keys)

func (*Value) UnmarshalCBOR

func (v *Value) UnmarshalCBOR(data []byte) error