1# Project information 2site_name: JSON for Modern C++ 3site_author: Niels Lohmann 4site_url: https://json.nlohmann.me/ 5 6# Repository 7repo_name: nlohmann/json 8repo_url: https://github.com/nlohmann/json 9edit_uri: edit/develop/docs/mkdocs/docs 10 11# Copyright 12copyright: Copyright © 2013 - 2022 Niels Lohmann 13 14# Configuration 15theme: 16 name: material 17 language: en 18 palette: 19 primary: indigo 20 accent: indigo 21 font: 22 text: Roboto 23 code: JetBrains Mono 24 features: 25 - navigation.instant 26 - navigation.tracking 27 - navigation.tabs 28 - navigation.indexes 29 - navigation.top 30 31nav: 32 - Home: 33 - index.md 34 - home/license.md 35 - "Code of Conduct": home/code_of_conduct.md 36 - "FAQ": home/faq.md 37 - home/exceptions.md 38 - home/releases.md 39 - home/design_goals.md 40 - home/sponsors.md 41 - Features: 42 - features/arbitrary_types.md 43 - Binary Formats: 44 - features/binary_formats/index.md 45 - features/binary_formats/bjdata.md 46 - features/binary_formats/bson.md 47 - features/binary_formats/cbor.md 48 - features/binary_formats/messagepack.md 49 - features/binary_formats/ubjson.md 50 - features/binary_values.md 51 - features/comments.md 52 - Element Access: 53 - features/element_access/index.md 54 - features/element_access/unchecked_access.md 55 - features/element_access/checked_access.md 56 - features/element_access/default_value.md 57 - features/iterators.md 58 - features/json_pointer.md 59 - features/json_patch.md 60 - features/merge_patch.md 61 - 'nlohmann Namespace': features/namespace.md 62 - features/object_order.md 63 - Parsing: 64 - features/parsing/index.md 65 - features/parsing/json_lines.md 66 - features/parsing/parse_exceptions.md 67 - features/parsing/parser_callbacks.md 68 - features/parsing/sax_interface.md 69 - features/assertions.md 70 - features/enum_conversion.md 71 - features/macros.md 72 - Types: 73 - features/types/index.md 74 - features/types/number_handling.md 75 - Integration: 76 - integration/index.md 77 - integration/cmake.md 78 - integration/package_managers.md 79 - integration/pkg-config.md 80 - API Documentation: 81 - basic_json: 82 - 'Overview': api/basic_json/index.md 83 - '(Constructor)': api/basic_json/basic_json.md 84 - '(Destructor)': api/basic_json/~basic_json.md 85 - 'accept': api/basic_json/accept.md 86 - 'array': api/basic_json/array.md 87 - 'array_t': api/basic_json/array_t.md 88 - 'at': api/basic_json/at.md 89 - 'back': api/basic_json/back.md 90 - 'begin': api/basic_json/begin.md 91 - 'binary': api/basic_json/binary.md 92 - 'binary_t': api/basic_json/binary_t.md 93 - 'boolean_t': api/basic_json/boolean_t.md 94 - 'cbegin': api/basic_json/cbegin.md 95 - 'cbor_tag_handler_t': api/basic_json/cbor_tag_handler_t.md 96 - 'cend': api/basic_json/cend.md 97 - 'clear': api/basic_json/clear.md 98 - 'contains': api/basic_json/contains.md 99 - 'count': api/basic_json/count.md 100 - 'crbegin': api/basic_json/crbegin.md 101 - 'crend': api/basic_json/crend.md 102 - 'default_object_comparator_t': api/basic_json/default_object_comparator_t.md 103 - 'diff': api/basic_json/diff.md 104 - 'dump': api/basic_json/dump.md 105 - 'emplace': api/basic_json/emplace.md 106 - 'emplace_back': api/basic_json/emplace_back.md 107 - 'empty': api/basic_json/empty.md 108 - 'end': api/basic_json/end.md 109 - 'erase': api/basic_json/erase.md 110 - 'error_handler_t': api/basic_json/error_handler_t.md 111 - 'exception': api/basic_json/exception.md 112 - 'find': api/basic_json/find.md 113 - 'flatten': api/basic_json/flatten.md 114 - 'from_bjdata': api/basic_json/from_bjdata.md 115 - 'from_bson': api/basic_json/from_bson.md 116 - 'from_cbor': api/basic_json/from_cbor.md 117 - 'from_msgpack': api/basic_json/from_msgpack.md 118 - 'from_ubjson': api/basic_json/from_ubjson.md 119 - 'front': api/basic_json/front.md 120 - 'get': api/basic_json/get.md 121 - 'get_allocator': api/basic_json/get_allocator.md 122 - 'get_binary': api/basic_json/get_binary.md 123 - 'get_ptr': api/basic_json/get_ptr.md 124 - 'get_ref': api/basic_json/get_ref.md 125 - 'get_to': api/basic_json/get_to.md 126 - 'std::hash<basic_json>': api/basic_json/std_hash.md 127 - 'input_format_t': api/basic_json/input_format_t.md 128 - 'insert': api/basic_json/insert.md 129 - 'invalid_iterator': api/basic_json/invalid_iterator.md 130 - 'is_array': api/basic_json/is_array.md 131 - 'is_binary': api/basic_json/is_binary.md 132 - 'is_boolean': api/basic_json/is_boolean.md 133 - 'is_discarded': api/basic_json/is_discarded.md 134 - 'is_null': api/basic_json/is_null.md 135 - 'is_number': api/basic_json/is_number.md 136 - 'is_number_float': api/basic_json/is_number_float.md 137 - 'is_number_integer': api/basic_json/is_number_integer.md 138 - 'is_number_unsigned': api/basic_json/is_number_unsigned.md 139 - 'is_object': api/basic_json/is_object.md 140 - 'is_primitive': api/basic_json/is_primitive.md 141 - 'is_string': api/basic_json/is_string.md 142 - 'is_structured': api/basic_json/is_structured.md 143 - 'items': api/basic_json/items.md 144 - 'json_serializer': api/basic_json/json_serializer.md 145 - 'max_size': api/basic_json/max_size.md 146 - 'meta': api/basic_json/meta.md 147 - 'merge_patch': api/basic_json/merge_patch.md 148 - 'number_float_t': api/basic_json/number_float_t.md 149 - 'number_integer_t': api/basic_json/number_integer_t.md 150 - 'number_unsigned_t': api/basic_json/number_unsigned_t.md 151 - 'object': api/basic_json/object.md 152 - 'object_comparator_t': api/basic_json/object_comparator_t.md 153 - 'object_t': api/basic_json/object_t.md 154 - 'operator ValueType': api/basic_json/operator_ValueType.md 155 - 'operator value_t': api/basic_json/operator_value_t.md 156 - 'operator[]': api/basic_json/operator[].md 157 - 'operator=': api/basic_json/operator=.md 158 - 'operator+=': api/basic_json/operator+=.md 159 - 'operator==': api/basic_json/operator_eq.md 160 - 'operator!=': api/basic_json/operator_ne.md 161 - 'operator<': api/basic_json/operator_lt.md 162 - 'operator>': api/basic_json/operator_gt.md 163 - 'operator<=': api/basic_json/operator_le.md 164 - 'operator>=': api/basic_json/operator_ge.md 165 - 'operator<=>': api/basic_json/operator_spaceship.md 166 - 'out_of_range': api/basic_json/out_of_range.md 167 - 'other_error': api/basic_json/other_error.md 168 - 'parse': api/basic_json/parse.md 169 - 'parse_error': api/basic_json/parse_error.md 170 - 'parse_event_t': api/basic_json/parse_event_t.md 171 - 'parser_callback_t': api/basic_json/parser_callback_t.md 172 - 'patch': api/basic_json/patch.md 173 - 'patch_inplace': api/basic_json/patch_inplace.md 174 - 'push_back': api/basic_json/push_back.md 175 - 'rbegin': api/basic_json/rbegin.md 176 - 'rend': api/basic_json/rend.md 177 - 'sax_parse': api/basic_json/sax_parse.md 178 - 'size': api/basic_json/size.md 179 - 'string_t': api/basic_json/string_t.md 180 - 'swap': api/basic_json/swap.md 181 - 'std::swap<basic_json>': api/basic_json/std_swap.md 182 - 'to_bjdata': api/basic_json/to_bjdata.md 183 - 'to_bson': api/basic_json/to_bson.md 184 - 'to_cbor': api/basic_json/to_cbor.md 185 - 'to_msgpack': api/basic_json/to_msgpack.md 186 - 'to_string': api/basic_json/to_string.md 187 - 'to_ubjson': api/basic_json/to_ubjson.md 188 - 'type': api/basic_json/type.md 189 - 'type_error': api/basic_json/type_error.md 190 - 'type_name': api/basic_json/type_name.md 191 - 'unflatten': api/basic_json/unflatten.md 192 - 'update': api/basic_json/update.md 193 - 'value': api/basic_json/value.md 194 - 'value_t': api/basic_json/value_t.md 195 - byte_container_with_subtype: 196 - 'Overview': api/byte_container_with_subtype/index.md 197 - '(constructor)': api/byte_container_with_subtype/byte_container_with_subtype.md 198 - 'clear_subtype': api/byte_container_with_subtype/clear_subtype.md 199 - 'has_subtype': api/byte_container_with_subtype/has_subtype.md 200 - 'set_subtype': api/byte_container_with_subtype/set_subtype.md 201 - 'subtype': api/byte_container_with_subtype/subtype.md 202 - adl_serializer: 203 - 'Overview': api/adl_serializer/index.md 204 - 'from_json': api/adl_serializer/from_json.md 205 - 'to_json': api/adl_serializer/to_json.md 206 - 'json': api/json.md 207 - json_pointer: 208 - 'Overview': api/json_pointer/index.md 209 - '(Constructor)': api/json_pointer/json_pointer.md 210 - 'back': api/json_pointer/back.md 211 - 'empty': api/json_pointer/empty.md 212 - 'operator string_t': api/json_pointer/operator_string_t.md 213 - 'operator==': api/json_pointer/operator_eq.md 214 - 'operator!=': api/json_pointer/operator_ne.md 215 - 'operator/': api/json_pointer/operator_slash.md 216 - 'operator/=': api/json_pointer/operator_slasheq.md 217 - 'parent_pointer': api/json_pointer/parent_pointer.md 218 - 'pop_back': api/json_pointer/pop_back.md 219 - 'push_back': api/json_pointer/push_back.md 220 - 'string_t': api/json_pointer/string_t.md 221 - 'to_string': api/json_pointer/to_string.md 222 - json_sax: 223 - 'Overview': api/json_sax/index.md 224 - 'binary': api/json_sax/binary.md 225 - 'boolean': api/json_sax/boolean.md 226 - 'end_array': api/json_sax/end_array.md 227 - 'end_object': api/json_sax/end_object.md 228 - 'key': api/json_sax/key.md 229 - 'null': api/json_sax/null.md 230 - 'number_float': api/json_sax/number_float.md 231 - 'number_integer': api/json_sax/number_integer.md 232 - 'number_unsigned': api/json_sax/number_unsigned.md 233 - 'parse_error': api/json_sax/parse_error.md 234 - 'start_array': api/json_sax/start_array.md 235 - 'start_object': api/json_sax/start_object.md 236 - 'string': api/json_sax/string.md 237 - 'operator<<(basic_json)': api/operator_ltlt.md 238 - 'operator<<(json_pointer)': api/operator_ltlt.md 239 - 'operator>>(basic_json)': api/operator_gtgt.md 240 - 'operator""_json': api/operator_literal_json.md 241 - 'operator""_json_pointer': api/operator_literal_json_pointer.md 242 - 'ordered_json': api/ordered_json.md 243 - 'ordered_map': api/ordered_map.md 244 - macros: 245 - 'Overview': api/macros/index.md 246 - 'JSON_ASSERT': api/macros/json_assert.md 247 - 'JSON_CATCH_USER': api/macros/json_throw_user.md 248 - 'JSON_DIAGNOSTICS': api/macros/json_diagnostics.md 249 - 'JSON_DISABLE_ENUM_SERIALIZATION': api/macros/json_disable_enum_serialization.md 250 - 'JSON_HAS_CPP_11': api/macros/json_has_cpp_11.md 251 - 'JSON_HAS_CPP_14': api/macros/json_has_cpp_11.md 252 - 'JSON_HAS_CPP_17': api/macros/json_has_cpp_11.md 253 - 'JSON_HAS_CPP_20': api/macros/json_has_cpp_11.md 254 - 'JSON_HAS_EXPERIMENTAL_FILESYSTEM': api/macros/json_has_filesystem.md 255 - 'JSON_HAS_FILESYSTEM': api/macros/json_has_filesystem.md 256 - 'JSON_HAS_RANGES': api/macros/json_has_ranges.md 257 - 'JSON_HAS_THREE_WAY_COMPARISON': api/macros/json_has_three_way_comparison.md 258 - 'JSON_NOEXCEPTION': api/macros/json_noexception.md 259 - 'JSON_NO_IO': api/macros/json_no_io.md 260 - 'JSON_SKIP_LIBRARY_VERSION_CHECK': api/macros/json_skip_library_version_check.md 261 - 'JSON_SKIP_UNSUPPORTED_COMPILER_CHECK': api/macros/json_skip_unsupported_compiler_check.md 262 - 'JSON_THROW_USER': api/macros/json_throw_user.md 263 - 'JSON_TRY_USER': api/macros/json_throw_user.md 264 - 'JSON_USE_GLOBAL_UDLS': api/macros/json_use_global_udls.md 265 - 'JSON_USE_IMPLICIT_CONVERSIONS': api/macros/json_use_implicit_conversions.md 266 - 'JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON': api/macros/json_use_legacy_discarded_value_comparison.md 267 - 'NLOHMANN_DEFINE_TYPE_INTRUSIVE': api/macros/nlohmann_define_type_intrusive.md 268 - 'NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT': api/macros/nlohmann_define_type_intrusive.md 269 - 'NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE': api/macros/nlohmann_define_type_non_intrusive.md 270 - 'NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT': api/macros/nlohmann_define_type_non_intrusive.md 271 - 'NLOHMANN_JSON_NAMESPACE': api/macros/nlohmann_json_namespace.md 272 - 'NLOHMANN_JSON_NAMESPACE_BEGIN': api/macros/nlohmann_json_namespace_begin.md 273 - 'NLOHMANN_JSON_NAMESPACE_END': api/macros/nlohmann_json_namespace_begin.md 274 - 'NLOHMANN_JSON_NAMESPACE_NO_VERSION': api/macros/nlohmann_json_namespace_no_version.md 275 - 'NLOHMANN_JSON_SERIALIZE_ENUM': api/macros/nlohmann_json_serialize_enum.md 276 - 'NLOHMANN_JSON_VERSION_MAJOR': api/macros/nlohmann_json_version_major.md 277 - 'NLOHMANN_JSON_VERSION_MINOR': api/macros/nlohmann_json_version_major.md 278 - 'NLOHMANN_JSON_VERSION_PATCH': api/macros/nlohmann_json_version_major.md 279 280# Extras 281extra: 282 social: 283 - icon: fontawesome/brands/github 284 link: https://github.com/nlohmann 285 - icon: fontawesome/brands/twitter 286 link: https://twitter.com/nlohmann 287 - icon: fontawesome/brands/linkedin 288 link: https://www.linkedin.com/in/nielslohmann/ 289 - icon: fontawesome/brands/xing 290 link: https://www.xing.com/profile/Niels_Lohmann 291 - icon: fontawesome/brands/paypal 292 link: https://www.paypal.me/nlohmann 293 generator: false 294 295# Extensions 296markdown_extensions: 297 - abbr 298 - admonition 299 - attr_list 300 - def_list 301 - codehilite: 302 guess_lang: false 303 - toc: 304 permalink: true 305 - pymdownx.arithmatex 306 - pymdownx.betterem: 307 smart_enable: all 308 - pymdownx.caret 309 - pymdownx.critic 310 - pymdownx.details 311 - pymdownx.emoji: 312 emoji_index: !!python/name:materialx.emoji.twemoji 313 emoji_generator: !!python/name:materialx.emoji.to_svg 314 - pymdownx.inlinehilite 315 - pymdownx.magiclink 316 - pymdownx.mark 317 #- pymdownx.smartsymbols 318 - pymdownx.superfences 319 - pymdownx.tasklist: 320 custom_checkbox: true 321 - pymdownx.tabbed 322 - pymdownx.tilde 323 - pymdownx.snippets: 324 base_path: docs 325 check_paths: true 326 - plantuml_markdown: 327 format: svg 328 329plugins: 330 - search: 331 separator: '[\s\-\.]' 332 lang: en 333 - minify: 334 minify_html: true 335 - git-revision-date-localized 336 - redirects: 337 redirect_maps: 338 'api/basic_json/operator_gtgt.md': api/operator_gtgt.md 339 'api/basic_json/operator_ltlt.md': api/operator_ltlt.md 340 'api/basic_json/operator_literal_json.md': api/operator_literal_json.md 341 'api/basic_json/operator_literal_json_pointer.md': api/operator_literal_json_pointer.md 342 'api/json_pointer/operator_string.md': api/json_pointer/operator_string_t.md 343 344extra_css: 345 - css/custom.css 346 347extra_javascript: 348 - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML 349