xref: /freebsd-src/contrib/libcbor/doc/source/index.rst (revision abd872540f24cfc7dbd1ea29b6918c7082a22108)
110ff414cSEd Mastelibcbor
210ff414cSEd Maste===================================
310ff414cSEd Maste
410ff414cSEd MasteDocumentation for version |release|, updated on |today|.
510ff414cSEd Maste
610ff414cSEd MasteOverview
710ff414cSEd Maste--------
810ff414cSEd Maste*libcbor* is a C library for parsing and generating CBOR_, the general-purpose schema-less binary data format.
910ff414cSEd Maste
1010ff414cSEd Maste
1110ff414cSEd MasteMain features
12*abd87254SEd Maste - Complete `IETF RFC 8949 (STD 94) <https://www.rfc-editor.org/info/std94>`_ conformance [#]_
1310ff414cSEd Maste - Robust C99 implementation
1410ff414cSEd Maste - Layered architecture offers both control and convenience
1510ff414cSEd Maste - Flexible memory management
1610ff414cSEd Maste - No shared global state - threading friendly [#]_
1710ff414cSEd Maste - Proper handling of UTF-8
1810ff414cSEd Maste - Full support for streams & incremental processing
1910ff414cSEd Maste - Extensive documentation and test suite
2010ff414cSEd Maste - No runtime dependencies, small footprint
2110ff414cSEd Maste
22*abd87254SEd Maste.. [#] See :doc:`standard_conformance`
2310ff414cSEd Maste
2410ff414cSEd Maste.. [#] With the exception of custom memory allocators (see :doc:`api/item_reference_counting`)
2510ff414cSEd Maste
2610ff414cSEd MasteContents
2710ff414cSEd Maste----------
2810ff414cSEd Maste.. toctree::
2910ff414cSEd Maste
3010ff414cSEd Maste   getting_started
3110ff414cSEd Maste   using
3210ff414cSEd Maste   api
3310ff414cSEd Maste   tests
34*abd87254SEd Maste   standard_conformance
3510ff414cSEd Maste   internal
3610ff414cSEd Maste   changelog
3710ff414cSEd Maste   development
3810ff414cSEd Maste
39*abd87254SEd Maste.. _CBOR: https://www.rfc-editor.org/info/std94
40