cbor

Documentation

Overview

Package cbor contains a codec implementation that marshals in CBOR format.

Index

• Variables
• type Codec
  • func (Codec) BasicMediaType() string
  • func (Codec) Marshal(v any) ([]byte, error)
  • func (Codec) Query(types []reflect.Type) codec.Capabilities
  • func (Codec) Unmarshal(data []byte, v any) error

Variables

var DefaultCodec = Codec{}

DefaultCodec is a marshalkit.Codec that marshals messages using CBOR encoding.

Types

type Codec

type Codec struct{}

Codec is an implementation of marshalkit.Codec that uses CBOR encoding.

func (Codec) BasicMediaType

func (Codec) BasicMediaType() string

BasicMediaType returns the type and subtype portion of the media-type used to identify data encoded by this codec.

func (Codec) Marshal

func (Codec) Marshal(v any) ([]byte, error)

Marshal returns the binary representation of v.

func (Codec) Query

func (Codec) Query(types []reflect.Type) codec.Capabilities

Query returns the capabilities of the codec for the given types.

func (Codec) Unmarshal

func (Codec) Unmarshal(data []byte, v any) error

Unmarshal decodes a binary representation into v.