Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cbor

package

Go to main page

Versions in this module

v1

v1.3.3

Sep 29, 2026

v1.3.2

Sep 28, 2026

v1.3.1

Sep 25, 2026

v1.3.0

Sep 25, 2026

v1.2.12

Sep 3, 2026

v1.2.11

Sep 2, 2026

v1.2.10

Aug 29, 2026

v1.2.9

Aug 20, 2026

v1.2.8

Aug 20, 2026

v1.2.7

Aug 20, 2026

Changes in this version

type Profile

+ KeyOrder KeyOrder

+ RejectFloats bool

+ RejectIndefinite bool

+ RejectMaps bool

+ RejectTags bool

+ RejectTextKeys bool

+ RequireSortedKeys bool

+ func Canonical() Profile

+ func Deterministic() Profile

v1.2.6

Aug 19, 2026

Changes in this version

type Profile

+ func (p Profile) MaxContainerItems() int

+ func (p Profile) MaxInputBytes() int64

+ func (p Profile) MaxNestedLevels() int

+ func (p Profile) WithMaxNestedLevels(n int) Profile

v1.2.5

Aug 19, 2026

Changes in this version

+ var ErrDuplicateMapKey = errors.New("cbor: duplicate map key")

+ var ErrExtraneousData = errors.New("cbor: extraneous data after root item")

+ var ErrFloatRefused = fmt.Errorf("%w: float", ErrProfileViolation)

+ var ErrIntegerOverflow = errors.New("cbor: integer does not fit int64")

+ var ErrLimitExceeded = errors.New("cbor: limit exceeded")

+ var ErrMalformed = errors.New("cbor: malformed input")

+ var ErrProfileViolation = errors.New("cbor: profile violation")

+ var ErrTruncated = errors.New("cbor: truncated input")

+ var ErrUnexpectedToken = errors.New("cbor: unexpected token")

+ func AppendArrayHeader(dst []byte, n int) []byte

+ func AppendBool(dst []byte, v bool) []byte

+ func AppendBytes(dst, v []byte) []byte

+ func AppendFloat(dst []byte, v float64) []byte

+ func AppendInt(dst []byte, v int64) []byte

+ func AppendMapHeader(dst []byte, n int) []byte

+ func AppendNegative(dst []byte, arg uint64) []byte

+ func AppendNull(dst []byte) []byte

+ func AppendRaw(dst []byte, raw RawMessage) []byte

+ func AppendTag(dst []byte, tag uint64) []byte

+ func AppendText(dst []byte, v string) []byte

+ func AppendUint(dst []byte, v uint64) []byte

+ func Validate(data []byte, opts DecoderOptions) error

+ type Appender interface

+ AppendCBORTo func(dst []byte) []byte

+ type Decodable interface

+ DecodeCBORFrom func(data []byte) error

+ type Decoder struct

+ func NewDecoder(r io.Reader, opts DecoderOptions) (*Decoder, error)

+ func (d *Decoder) ReadArray() (length int, indefinite bool, err error)

+ func (d *Decoder) ReadBool() (bool, error)

+ func (d *Decoder) ReadBytes() ([]byte, error)

+ func (d *Decoder) ReadFloat() (float64, error)

+ func (d *Decoder) ReadInt() (int64, error)

+ func (d *Decoder) ReadMap() (pairs int, indefinite bool, err error)

+ func (d *Decoder) ReadNull() error

+ func (d *Decoder) ReadRaw() (RawMessage, error)

+ func (d *Decoder) ReadTag() (uint64, error)

+ func (d *Decoder) ReadText() (string, error)

+ func (d *Decoder) ReadToken() (Token, error)

+ func (d *Decoder) ReadUint() (uint64, error)

+ type DecoderOptions struct

+ MaxContainerItems int

+ MaxInputBytes int64

+ MaxNestedLevels int

+ MaxRawMessageBytes int

+ MaxStringBytes int

+ RejectDuplicateMapKeys bool

+ RejectFloats bool

+ Sequence bool

+ type Encoder struct

+ func NewEncoder(w io.Writer, opts EncoderOptions) (*Encoder, error)

+ func (e *Encoder) Reset(w io.Writer) error

+ func (e *Encoder) WriteArray(items []RawMessage) error

+ func (e *Encoder) WriteBool(v bool) error

+ func (e *Encoder) WriteBytes(v []byte) error

+ func (e *Encoder) WriteFloat(v float64) error

+ func (e *Encoder) WriteInt(v int64) error

+ func (e *Encoder) WriteMap(entries []MapEntry) error

+ func (e *Encoder) WriteNegative(arg uint64) error

+ func (e *Encoder) WriteNull() error

+ func (e *Encoder) WriteRaw(raw RawMessage) error

+ func (e *Encoder) WriteTag(tag uint64, content RawMessage) error

+ func (e *Encoder) WriteText(v string) error

+ func (e *Encoder) WriteUint(v uint64) error

+ type EncoderOptions struct

+ KeyOrder KeyOrder

+ MaxContainerItems int

+ MaxNestedLevels int

+ MaxStringBytes int

+ type Error struct

+ Err error

+ Offset int64

+ Path string

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type KeyOrder uint8

+ const BytewiseKeyOrder

+ const LengthFirstKeyOrder

+ func (o KeyOrder) String() string

+ type MapEntry struct

+ Key RawMessage

+ Value RawMessage

+ type Profile struct

+ func Wire() Profile

+ func World() Profile

+ func (p Profile) AllowingFloats() Profile

+ func (p Profile) DecoderOptions() DecoderOptions

+ func (p Profile) EncoderOptions() EncoderOptions

+ func (p Profile) Name() string

+ func (p Profile) NewReader(data []byte) (*Reader, error)

+ func (p Profile) ReaderOver(data []byte) Reader

+ func (p Profile) Validate(data []byte) error

+ func (p Profile) ValidateAppended(dst []byte, before int) error

+ func (p Profile) WithMaxInputBytes(n int64) Profile

+ type RawMessage []byte

+ func MarshalBool(v bool) RawMessage

+ func MarshalBytes(v []byte) RawMessage

+ func MarshalFloat(v float64) RawMessage

+ func MarshalInt(v int64) RawMessage

+ func MarshalNegative(arg uint64) RawMessage

+ func MarshalNull() RawMessage

+ func MarshalText(v string) (RawMessage, error)

+ func MarshalUint(v uint64) RawMessage

+ type Reader struct

+ func NewReader(data []byte, opts DecoderOptions) (*Reader, error)

+ func ReaderOver(data []byte, opts DecoderOptions) Reader

+ func (r *Reader) Done() bool

+ func (r *Reader) Offset() int

+ func (r *Reader) Peek() (TokenKind, error)

+ func (r *Reader) ReadArrayHeader() (length int, indefinite bool, err error)

+ func (r *Reader) ReadBool() (bool, error)

+ func (r *Reader) ReadBreak() error

+ func (r *Reader) ReadBytes() ([]byte, error)

+ func (r *Reader) ReadFloat() (float64, error)

+ func (r *Reader) ReadInt() (int64, error)

+ func (r *Reader) ReadInt16() (int16, error)

+ func (r *Reader) ReadInt32() (int32, error)

+ func (r *Reader) ReadInt64() (int64, error)

+ func (r *Reader) ReadInt8() (int8, error)

+ func (r *Reader) ReadMapHeader() (pairs int, indefinite bool, err error)

+ func (r *Reader) ReadNull() error

+ func (r *Reader) ReadRaw() (RawMessage, error)

+ func (r *Reader) ReadTag() (uint64, error)

+ func (r *Reader) ReadText() (string, error)

+ func (r *Reader) ReadTextBytes() ([]byte, error)

+ func (r *Reader) ReadUint() (uint64, error)

+ func (r *Reader) ReadUint16() (uint16, error)

+ func (r *Reader) ReadUint32() (uint32, error)

+ func (r *Reader) ReadUint64() (uint64, error)

+ func (r *Reader) ReadUint8() (uint8, error)

+ func (r *Reader) Remaining() int

+ func (r *Reader) Reset(data []byte)

+ func (r *Reader) Skip() error

+ type Token struct

+ Argument uint64

+ Bool bool

+ Bytes []byte

+ Float float64

+ Indefinite bool

+ Kind TokenKind

+ Length int

+ Text string

+ func (t Token) Int64() (int64, error)

+ type TokenKind uint8

+ const Boolean

+ const ByteString

+ const EndArray

+ const EndMap

+ const Float

+ const InvalidToken

+ const NegativeInteger

+ const Null

+ const StartArray

+ const StartMap

+ const Tag

+ const TextString

+ const UnsignedInteger

+ func (k TokenKind) String() string