QCBOR Documentation

QCBOR can be downloaded from its GitHub repository. This documentation corresponds to QCBOR v2, currently in its alpha release phase. While much of the content also applies to v1 – which is stable, commercially suitable, and compatible with v2 – it's important to note that v2 introduces new features and APIs not available in v1.

Table of Contents

API Reference:

• Common
  • Error codes and common constants: qcbor_common.h
  • Functions for managing buffers of binary data: UsefulBuf.h
• Encoding
  • Main/Basic encode functions: qcbor_main_encode.h
  • Number encode functions: qcbor_number_encode.h
  • Tag encode functions: qcbor_tag_encode.h
• Decoding
  • Main/Basic decode functions: qcbor_main_decode.h
  • Spiffy decode functions: qcbor_spiffy_decode.h
  • Tag decode functions: qcbor_tag_decode.h
  • Number decode functions: qcbor_number_decode.h

Subject Matter:

• QCBOR overview and implementation limits
• Building QCBOR with make and cmake
• Minimizing the amount of code linked and disabling features
• The 'spiffy' decode functions for easier map decoding
• CBOR Numbers
  • Characteristics, encoding and decoding big numbers
• Tags
  • CBORTags