libcbor

Documentation for version 0.2.1, updated on May 21, 2015.

Overview

libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.

Main features

• Complete RFC conformance [1]
• Robust C11 implementation
• Layered architecture offers both control and convenience
• Flexible memory management
• Proper handling of UTF-8
• No shared global state - threading friendly
• Full support for streams & incremental processing
• Extensive documentation and test suite
• No runtime dependencies, small footprint

[1]	RFC conformance

Contents

• Getting started
  • Building & installing libcbor
  • Linking with libcbor
  • MinGW build instructions
  • Troubleshooting
• Usage & preliminaries
  • Version information
  • Headers to include
  • Using libcbor
• API
  • Types of items
    • Binary queries
    • Logical queries
  • Memory management and reference counting
    • Using custom allocator
    • Reference counting
  • Decoding
    • Associated data structures
  • Encoding
    • Type-specific serializers
  • Types 0 & 1 – Positive and negative integers
    • Type 0 - positive integers
    • Type 1 - negative integers
    • Type 0 & 1
    • Building new items
    • Retrieving values
    • Setting values
    • Dealing with width
    • Dealing with signedness
    • Creating new items
  • Type 2 – Byte strings
    • Streaming indefinite byte strings
    • Getting metadata
    • Reading data
    • Creating new items
    • Building items
    • Manipulating existing items
  • Type 3 – UTF-8 strings
    • Streaming indefinite strings
    • UTF-8 encoding validation
    • Getting metadata
    • Reading data
    • Creating new items
    • Building items
    • Manipulating existing items
  • Type 4 – Arrays
    • Examples
    • Streaming indefinite arrays
    • Getting metadata
    • Reading data
    • Creating new items
    • Modifying items
  • Type 5 – Maps
    • Streaming maps
    • Getting metadata
    • Reading data
    • Creating new items
    • Modifying items
  • Type 6 – Semantic tags
  • Type 7 – Floats & control tokens
    • Getting metadata
    • Reading data
    • Creating new items
    • Building items
    • Manipulating existing items
• Streaming & indefinite items
  • Decoding
    • Related structures
    • Callback types definition
  • Encoding
• Tests
  • Unit tests
  • Testing for memory leaks
  • Code coverage
  • Fuzz testing
• RFC conformance
  • Bytestring length
  • “Half-precision” IEEE 754 floats
• Internal mechanics
  • Terminology
  • Conventions
  • Inspiration & related projects
  • General notes on the API design
  • Coding style
  • Memory layout
  • Decoding
• Changelog
  • Next
  • 0.2.1 (2015-05-17)
  • 0.2.0 (2015-05-17)
  • 0.1.0 (2015-05-06)
• Development
  • Development dependencies
    • Building cmocka
    • Installing sphinx
    • Live preview of docs
    • Testing and code coverage