opnsense-src/contrib/libcbor/doc/source/index.rst
Ed Maste 10ff414c14 Import libcbor at 'contrib/libcbor/'
git-subtree-dir: contrib/libcbor
git-subtree-mainline: 293663f4da
git-subtree-split: 5b2defbd2a
2021-10-06 20:26:10 -04:00

40 lines
947 B
ReStructuredText

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