summaryrefslogtreecommitdiff
path: root/external/mit/libcbor/dist/doc/source/index.rst
blob: 1922586097e3982e8f88b4a311468afdf9c0eca4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
libcbor
===================================

Documentation for version |release|, updated on |today|.

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


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

.. [#] See :doc:`rfc_conformance`

.. [#] With the exception of custom memory allocators (see :doc:`api/item_reference_counting`)

Contents
----------
.. toctree::

   getting_started
   using
   api
   streaming
   tests
   rfc_conformance
   internal
   changelog
   development

.. _CBOR: http://tools.ietf.org/html/rfc7049