JSON for Modern C++ 2.1.1
Loading...
Searching...
No Matches

◆ parse() [1/6]

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>
template<typename CharT , typename std::enable_if< std::is_pointer< CharT >::value and std::is_integral< typename std::remove_pointer< CharT >::type >::value and sizeof(typename std::remove_pointer< CharT >::type)==1, int >::type = 0>
static basic_json nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer >::parse ( const CharT  s,
const parser_callback_t  cb = nullptr 
)
inlinestatic
Template Parameters
CharTcharacter/literal type with size of 1 byte
Parameters
[in]sstring literal to read a serialized JSON value from
[in]cba parser callback function of type parser_callback_t which is used to control the deserialization by filtering unwanted values (optional)
Returns
result of the deserialization
Complexity\n Linear in the length of the input. The parser is a predictive
LL(1) parser. The complexity can be higher if the parser callback function cb has a super-linear complexity.
Note
A UTF-8 byte order mark is silently ignored.
String containers like std::string or string_t can be parsed with parse(const ContiguousContainer&, const parser_callback_t)
Example\n The example below demonstrates the parse() function with
and without callback function.
1#include <json.hpp>
2
3using json = nlohmann::json;
4
5int main()
6{
7 // a JSON text
8 auto text = R"(
9 {
10 "Image": {
11 "Width": 800,
12 "Height": 600,
13 "Title": "View from 15th Floor",
14 "Thumbnail": {
15 "Url": "http://www.example.com/image/481989943",
16 "Height": 125,
17 "Width": 100
18 },
19 "Animated" : false,
20 "IDs": [116, 943, 234, 38793]
21 }
22 }
23 )";
24
25 // parse and serialize JSON
27 std::cout << std::setw(4) << j_complete << "\n\n";
28
29
30 // define parser callback
32 {
33 // skip object elements with key "Thumbnail"
34 if (event == json::parse_event_t::key and parsed == json("Thumbnail"))
35 {
36 return false;
37 }
38 else
39 {
40 return true;
41 }
42 };
43
44 // parse (with callback) and serialize JSON
46 std::cout << std::setw(4) << j_filtered << '\n';
47}
static basic_json array(std::initializer_list< basic_json > init=std::initializer_list< basic_json >())
explicitly create an array from an initializer list
Definition json.hpp:2165
static basic_json parse(T(&array)[N], const parser_callback_t cb=nullptr)
deserialize from an array
Definition json.hpp:6284
parse_event_t
JSON callback events.
Definition json.hpp:1808
@ key
the parser read a key of a value in an object
std::function< bool(int depth, parse_event_t event, basic_json &parsed)> parser_callback_t
per-element parser callback type
Definition json.hpp:1877
a class to store JSON values
Definition json.hpp:1040
basic_json<> json
default JSON class
Definition json.hpp:12369

Output (play with this example online):
{
    "Image": {
        "Animated": false,
        "Height": 600,
        "IDs": [
            116,
            943,
            234,
            38793
        ],
        "Thumbnail": {
            "Height": 125,
            "Url": "http://www.example.com/image/481989943",
            "Width": 100
        },
        "Title": "View from 15th Floor",
        "Width": 800
    }
}

{
    "Image": {
        "Animated": false,
        "Height": 600,
        "IDs": [
            116,
            943,
            234,
            38793
        ],
        "Title": "View from 15th Floor",
        "Width": 800
    }
}

The example code above can be translated with
g++ -std=c++11 -Isrc doc/examples/parse__string__parser_callback_t.cpp -o parse__string__parser_callback_t 
See also
parse(std::istream&, const parser_callback_t) for a version that reads from an input stream
Since
version 1.0.0 (originally for string_t)

Definition at line 6322 of file json.hpp.