JSON for Modern C++ 3.7.1

accept
accept
allocator_type
array
array_t
at
at
at
at
at
at
back
back
basic_json
basic_json
basic_json
basic_json
basic_json
basic_json
basic_json
basic_json
basic_json
begin
begin
boolean_t
cbegin
cend
clear
const_iterator
const_pointer
const_reference
const_reverse_iterator
contains
contains
count
crbegin
crend
detail::external_constructor
diff
difference_type
dump
emplace
emplace_back
empty
end
end
erase
erase
erase
erase
error_handler_t
exception
find
find
flatten
from_bson
from_bson
from_cbor
from_cbor
from_msgpack
from_msgpack
from_ubjson
from_ubjson
front
front
get
get
get
get
get
get
get_allocator
get_ptr
get_ptr
get_ref
get_ref
get_to
get_to
initializer_list_t
input_format_t
insert
insert
insert
insert
insert
insert
insert_iterator
invalid_iterator
is_array
is_boolean
is_discarded
is_null
is_number
is_number_float
is_number_integer
is_number_unsigned
is_object
is_primitive
is_string
is_structured
items
items
iterator
iterator_wrapper
iterator_wrapper
json_pointer
json_sax_t
json_serializer
max_size
merge_patch
meta
number_float_t
number_integer_t
number_unsigned_t
object
object_comparator_t
object_t
operator value_t
operator ValueType
operator!=
operator!=
operator!=
operator+=
operator+=
operator+=
operator+=
operator<
operator<
operator<
operator<<
operator<<
operator<=
operator<=
operator<=
operator=
operator==
operator==
operator==
operator>
operator>
operator>
operator>=
operator>=
operator>=
operator>>
operator>>
operator[]
operator[]
operator[]
operator[]
operator[]
operator[]
operator[]
operator[]
other_error
out_of_range
parse
parse
parse_error
parse_event_t
parser_callback_t
patch
pointer
push_back
push_back
push_back
push_back
rbegin
rbegin
reference
rend
rend
reverse_iterator
sax_parse
sax_parse
size
size_type
string_t
swap
swap
swap
swap
to_bson
to_bson
to_bson
to_cbor
to_cbor
to_cbor
to_msgpack
to_msgpack
to_msgpack
to_ubjson
to_ubjson
to_ubjson
type
type_error
type_name
unflatten
update
update
value
value
value
value
value_t
value_type
~basic_json
| ## ◆ patch() template<template< typename U, typename V, typename... Args > class ObjectType = std::map, template< typename U, typename... Args > class ArrayType = std::vector, class StringType = std::string, class BooleanType = bool, class NumberIntegerType = std::int64_t, class NumberUnsignedType = std::uint64_t, class NumberFloatType = double, template< typename U > class AllocatorType = std::allocator, template< typename T, typename SFINAE=void > class JSONSerializer = adl_serializer>
basic_json nlohmann::basic_json::patch | ( | const basic_json & | json_patch | ) | const
| inline
  JSON Patch defines a JSON document structure for expressing a sequence of operations to apply to a JSON) document. With this function, a JSON Patch is applied to the current JSON value by executing all operations from the patch. Parameters
  [in] | json_patch | JSON patch document
  Returns patched document Note The application of a patch is atomic: Either all operations succeed and the patched document is returned or an exception is thrown. In any case, the original value is not changed: the patch is applied to a copy of the value. Exceptions
  parse_error.104 | if the JSON patch does not consist of an array of objects
  parse_error.105 | if the JSON patch is malformed (e.g., mandatory attributes are missing); example: `"operation add must have member path"`
  out_of_range.401 | if an array index is out of range.
  out_of_range.403 | if a JSON pointer inside the patch could not be resolved successfully in the current JSON value; example: `"key baz not found"`
  out_of_range.405 | if JSON pointer has no parent ("add", "remove", "move")
  other_error.501 | if "test" operation was unsuccessful
  Complexity Linear in the size of the JSON value and the length of the JSON patch. As usually only a fraction of the JSON value is affected by the patch, the complexity can usually be neglected. Example The following code shows how a JSON patch is applied to a value. 1 #include <iostream> 2 #include <iomanip> 3 #include <nlohmann/json.hpp> 4 5 using json = nlohmann::json; 6 7 int main() 8 { 9 // the original document 10 json doc = R"( 11 { 12 "baz": "qux", 13 "foo": "bar" 14 } 15 )"_json; 16 17 // the patch 18 json patch = R"( 19 [ 20 { "op": "replace", "path": "/baz", "value": "boo" }, 21 { "op": "add", "path": "/hello", "value": ["world"] }, 22 { "op": "remove", "path": "/foo"} 23 ] 24 )"_json; 25 26 // apply the patch 27 json patched_doc = doc.patch(patch); 28 29 // output original and patched document 30 std::cout << std::setw(4) << doc << "\n\n" 31 << std::setw(4) << patched_doc << std::endl; 32 } Output (play with this example online):
      {
          "baz": "qux",
          "foo": "bar"
      }

      {
          "baz": "boo",
          "hello": [
              "world"
          ]
      }
  The example code above can be translated with
      g++ -std=c++11 -Isingle_include doc/examples/patch.cpp -o patch
See also diff – create a JSON patch by comparing two JSON values RFC 6902 (JSON Patch) RFC 6901 (JSON Pointer) Since version 2.0.0 Definition at line 22073 of file json.hpp.

nlohmann::basic_json::patch
basic_json patch(const basic_json &json_patch) const
applies a JSON patch
Definition: json.hpp:22073
nlohmann::json
basic_json<> json
default JSON class
Definition: json.hpp:2445