# Project information site_name: JSON for Modern C++ site_author: Niels Lohmann site_url: https://json.nlohmann.me/ # Repository repo_name: nlohmann/json repo_url: https://github.com/nlohmann/json edit_uri: edit/develop/docs/mkdocs/docs # Copyright copyright: Copyright © 2013 - 2022 Niels Lohmann # Configuration theme: name: material language: en palette: primary: indigo accent: indigo font: text: Roboto code: JetBrains Mono features: - navigation.instant - navigation.tracking - navigation.tabs - navigation.indexes - navigation.top nav: - Home: - index.md - home/license.md - "Code of Conduct": home/code_of_conduct.md - "FAQ": home/faq.md - home/exceptions.md - home/releases.md - home/design_goals.md - home/sponsors.md - Features: - features/arbitrary_types.md - Binary Formats: - features/binary_formats/index.md - features/binary_formats/bjdata.md - features/binary_formats/bson.md - features/binary_formats/cbor.md - features/binary_formats/messagepack.md - features/binary_formats/ubjson.md - features/binary_values.md - features/comments.md - Element Access: - features/element_access/index.md - features/element_access/unchecked_access.md - features/element_access/checked_access.md - features/element_access/default_value.md - features/iterators.md - features/json_pointer.md - features/json_patch.md - features/merge_patch.md - features/object_order.md - Parsing: - features/parsing/index.md - features/parsing/json_lines.md - features/parsing/parse_exceptions.md - features/parsing/parser_callbacks.md - features/parsing/sax_interface.md - features/assertions.md - features/enum_conversion.md - features/macros.md - Types: - features/types/index.md - features/types/number_handling.md - Integration: - integration/index.md - integration/cmake.md - integration/package_managers.md - integration/pkg-config.md - API Documentation: - basic_json: - 'Overview': api/basic_json/index.md - '(Constructor)': api/basic_json/basic_json.md - '(Destructor)': api/basic_json/~basic_json.md - 'accept': api/basic_json/accept.md - 'array': api/basic_json/array.md - 'array_t': api/basic_json/array_t.md - 'at': api/basic_json/at.md - 'back': api/basic_json/back.md - 'begin': api/basic_json/begin.md - 'binary': api/basic_json/binary.md - 'binary_t': api/basic_json/binary_t.md - 'boolean_t': api/basic_json/boolean_t.md - 'cbegin': api/basic_json/cbegin.md - 'cbor_tag_handler_t': api/basic_json/cbor_tag_handler_t.md - 'cend': api/basic_json/cend.md - 'clear': api/basic_json/clear.md - 'contains': api/basic_json/contains.md - 'count': api/basic_json/count.md - 'crbegin': api/basic_json/crbegin.md - 'crend': api/basic_json/crend.md - 'default_object_comparator_t': api/basic_json/default_object_comparator_t.md - 'diff': api/basic_json/diff.md - 'dump': api/basic_json/dump.md - 'emplace': api/basic_json/emplace.md - 'emplace_back': api/basic_json/emplace_back.md - 'empty': api/basic_json/empty.md - 'end': api/basic_json/end.md - 'erase': api/basic_json/erase.md - 'error_handler_t': api/basic_json/error_handler_t.md - 'exception': api/basic_json/exception.md - 'find': api/basic_json/find.md - 'flatten': api/basic_json/flatten.md - 'from_bjdata': api/basic_json/from_bjdata.md - 'from_bson': api/basic_json/from_bson.md - 'from_cbor': api/basic_json/from_cbor.md - 'from_msgpack': api/basic_json/from_msgpack.md - 'from_ubjson': api/basic_json/from_ubjson.md - 'front': api/basic_json/front.md - 'get': api/basic_json/get.md - 'get_allocator': api/basic_json/get_allocator.md - 'get_binary': api/basic_json/get_binary.md - 'get_ptr': api/basic_json/get_ptr.md - 'get_ref': api/basic_json/get_ref.md - 'get_to': api/basic_json/get_to.md - 'std::hash<basic_json>': api/basic_json/std_hash.md - 'input_format_t': api/basic_json/input_format_t.md - 'insert': api/basic_json/insert.md - 'invalid_iterator': api/basic_json/invalid_iterator.md - 'is_array': api/basic_json/is_array.md - 'is_binary': api/basic_json/is_binary.md - 'is_boolean': api/basic_json/is_boolean.md - 'is_discarded': api/basic_json/is_discarded.md - 'is_null': api/basic_json/is_null.md - 'is_number': api/basic_json/is_number.md - 'is_number_float': api/basic_json/is_number_float.md - 'is_number_integer': api/basic_json/is_number_integer.md - 'is_number_unsigned': api/basic_json/is_number_unsigned.md - 'is_object': api/basic_json/is_object.md - 'is_primitive': api/basic_json/is_primitive.md - 'is_string': api/basic_json/is_string.md - 'is_structured': api/basic_json/is_structured.md - 'items': api/basic_json/items.md - 'json_serializer': api/basic_json/json_serializer.md - 'max_size': api/basic_json/max_size.md - 'meta': api/basic_json/meta.md - 'merge_patch': api/basic_json/merge_patch.md - 'number_float_t': api/basic_json/number_float_t.md - 'number_integer_t': api/basic_json/number_integer_t.md - 'number_unsigned_t': api/basic_json/number_unsigned_t.md - 'object': api/basic_json/object.md - 'object_comparator_t': api/basic_json/object_comparator_t.md - 'object_t': api/basic_json/object_t.md - 'operator ValueType': api/basic_json/operator_ValueType.md - 'operator value_t': api/basic_json/operator_value_t.md - 'operator[]': api/basic_json/operator[].md - 'operator=': api/basic_json/operator=.md - 'operator+=': api/basic_json/operator+=.md - 'operator==': api/basic_json/operator_eq.md - 'operator!=': api/basic_json/operator_ne.md - 'operator<': api/basic_json/operator_lt.md - 'operator>': api/basic_json/operator_gt.md - 'operator<=': api/basic_json/operator_le.md - 'operator>=': api/basic_json/operator_ge.md - 'operator<=>': api/basic_json/operator_spaceship.md - 'operator<<': api/basic_json/operator_ltlt.md - 'operator>>': api/basic_json/operator_gtgt.md - 'operator""_json': api/basic_json/operator_literal_json.md - 'operator""_json_pointer': api/basic_json/operator_literal_json_pointer.md - 'out_of_range': api/basic_json/out_of_range.md - 'other_error': api/basic_json/other_error.md - 'parse': api/basic_json/parse.md - 'parse_error': api/basic_json/parse_error.md - 'parse_event_t': api/basic_json/parse_event_t.md - 'parser_callback_t': api/basic_json/parser_callback_t.md - 'patch': api/basic_json/patch.md - 'push_back': api/basic_json/push_back.md - 'rbegin': api/basic_json/rbegin.md - 'rend': api/basic_json/rend.md - 'sax_parse': api/basic_json/sax_parse.md - 'size': api/basic_json/size.md - 'string_t': api/basic_json/string_t.md - 'swap': api/basic_json/swap.md - 'std::swap<basic_json>': api/basic_json/std_swap.md - 'to_bjdata': api/basic_json/to_bjdata.md - 'to_bson': api/basic_json/to_bson.md - 'to_cbor': api/basic_json/to_cbor.md - 'to_msgpack': api/basic_json/to_msgpack.md - 'to_string': api/basic_json/to_string.md - 'to_ubjson': api/basic_json/to_ubjson.md - 'type': api/basic_json/type.md - 'type_error': api/basic_json/type_error.md - 'type_name': api/basic_json/type_name.md - 'unflatten': api/basic_json/unflatten.md - 'update': api/basic_json/update.md - 'value': api/basic_json/value.md - 'value_t': api/basic_json/value_t.md - byte_container_with_subtype: - 'Overview': api/byte_container_with_subtype/index.md - '(constructor)': api/byte_container_with_subtype/byte_container_with_subtype.md - 'clear_subtype': api/byte_container_with_subtype/clear_subtype.md - 'has_subtype': api/byte_container_with_subtype/has_subtype.md - 'set_subtype': api/byte_container_with_subtype/set_subtype.md - 'subtype': api/byte_container_with_subtype/subtype.md - adl_serializer: - 'Overview': api/adl_serializer/index.md - 'from_json': api/adl_serializer/from_json.md - 'to_json': api/adl_serializer/to_json.md - 'json': api/json.md - json_pointer: - 'Overview': api/json_pointer/index.md - '(Constructor)': api/json_pointer/json_pointer.md - 'back': api/json_pointer/back.md - 'empty': api/json_pointer/empty.md - 'operator std::string': api/json_pointer/operator_string.md - 'operator/': api/json_pointer/operator_slash.md - 'operator/=': api/json_pointer/operator_slasheq.md - 'parent_pointer': api/json_pointer/parent_pointer.md - 'pop_back': api/json_pointer/pop_back.md - 'push_back': api/json_pointer/push_back.md - 'string_t': api/json_pointer/string_t.md - 'to_string': api/json_pointer/to_string.md - json_sax: - 'Overview': api/json_sax/index.md - 'binary': api/json_sax/binary.md - 'boolean': api/json_sax/boolean.md - 'end_array': api/json_sax/end_array.md - 'end_object': api/json_sax/end_object.md - 'key': api/json_sax/key.md - 'null': api/json_sax/null.md - 'number_float': api/json_sax/number_float.md - 'number_integer': api/json_sax/number_integer.md - 'number_unsigned': api/json_sax/number_unsigned.md - 'parse_error': api/json_sax/parse_error.md - 'start_array': api/json_sax/start_array.md - 'start_object': api/json_sax/start_object.md - 'string': api/json_sax/string.md - 'ordered_json': api/ordered_json.md - 'ordered_map': api/ordered_map.md - macros: - 'Overview': api/macros/index.md - 'JSON_ASSERT': api/macros/json_assert.md - 'JSON_CATCH_USER': api/macros/json_throw_user.md - 'JSON_DIAGNOSTICS': api/macros/json_diagnostics.md - 'JSON_HAS_CPP_11': api/macros/json_has_cpp_11.md - 'JSON_HAS_CPP_14': api/macros/json_has_cpp_11.md - 'JSON_HAS_CPP_17': api/macros/json_has_cpp_11.md - 'JSON_HAS_CPP_20': api/macros/json_has_cpp_11.md - 'JSON_HAS_EXPERIMENTAL_FILESYSTEM': api/macros/json_has_filesystem.md - 'JSON_HAS_FILESYSTEM': api/macros/json_has_filesystem.md - 'JSON_HAS_RANGES': api/macros/json_has_ranges.md - 'JSON_HAS_THREE_WAY_COMPARISON': api/macros/json_has_three_way_comparison.md - 'JSON_NOEXCEPTION': api/macros/json_noexception.md - 'JSON_NO_IO': api/macros/json_no_io.md - 'JSON_SKIP_LIBRARY_VERSION_CHECK': api/macros/json_skip_library_version_check.md - 'JSON_SKIP_UNSUPPORTED_COMPILER_CHECK': api/macros/json_skip_unsupported_compiler_check.md - 'JSON_THROW_USER': api/macros/json_throw_user.md - 'JSON_TRY_USER': api/macros/json_throw_user.md - 'JSON_USE_IMPLICIT_CONVERSIONS': api/macros/json_use_implicit_conversions.md - 'JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON': api/macros/json_use_legacy_discarded_value_comparison.md - 'NLOHMANN_DEFINE_TYPE_INTRUSIVE': api/macros/nlohmann_define_type_intrusive.md - 'NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT': api/macros/nlohmann_define_type_intrusive.md - 'NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE': api/macros/nlohmann_define_type_non_intrusive.md - 'NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT': api/macros/nlohmann_define_type_non_intrusive.md - 'NLOHMANN_JSON_SERIALIZE_ENUM': api/macros/nlohmann_json_serialize_enum.md - 'NLOHMANN_JSON_VERSION_MAJOR': api/macros/nlohmann_json_version_major.md - 'NLOHMANN_JSON_VERSION_MINOR': api/macros/nlohmann_json_version_major.md - 'NLOHMANN_JSON_VERSION_PATCH': api/macros/nlohmann_json_version_major.md # Extras extra: social: - icon: fontawesome/brands/github link: https://github.com/nlohmann - icon: fontawesome/brands/twitter link: https://twitter.com/nlohmann - icon: fontawesome/brands/linkedin link: https://www.linkedin.com/in/nielslohmann/ - icon: fontawesome/brands/xing link: https://www.xing.com/profile/Niels_Lohmann - icon: fontawesome/brands/paypal link: https://www.paypal.me/nlohmann generator: false # Extensions markdown_extensions: - abbr - admonition - attr_list - def_list - codehilite: guess_lang: false - toc: permalink: true - pymdownx.arithmatex - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.critic - pymdownx.details - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg - pymdownx.inlinehilite - pymdownx.magiclink - pymdownx.mark #- pymdownx.smartsymbols - pymdownx.superfences - pymdownx.tasklist: custom_checkbox: true - pymdownx.tabbed - pymdownx.tilde - pymdownx.snippets: base_path: docs check_paths: true - plantuml_markdown: format: svg plugins: - search: separator: '[\s\-\.]' lang: en - minify: minify_html: true - git-revision-date-localized extra_css: - css/custom.css extra_javascript: - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML