xref: /freebsd/contrib/libcbor/doc/source/index.rst (revision 81ad6265)
1libcbor
2===================================
3
4Documentation for version |release|, updated on |today|.
5
6Overview
7--------
8*libcbor* is a C library for parsing and generating CBOR_, the general-purpose schema-less binary data format.
9
10
11Main features
12 - Complete RFC conformance [#]_
13 - Robust C99 implementation
14 - Layered architecture offers both control and convenience
15 - Flexible memory management
16 - No shared global state - threading friendly [#]_
17 - Proper handling of UTF-8
18 - Full support for streams & incremental processing
19 - Extensive documentation and test suite
20 - No runtime dependencies, small footprint
21
22.. [#] See :doc:`rfc_conformance`
23
24.. [#] With the exception of custom memory allocators (see :doc:`api/item_reference_counting`)
25
26Contents
27----------
28.. toctree::
29
30   getting_started
31   using
32   api
33   streaming
34   tests
35   rfc_conformance
36   internal
37   changelog
38   development
39
40.. _CBOR: http://tools.ietf.org/html/rfc7049
41