-
Notifications
You must be signed in to change notification settings - Fork 94
/
parse.hpp
214 lines (164 loc) · 6.11 KB
/
parse.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
//
// Copyright (c) 2019 Vinnie Falco (vinnie.falco@gmail.com)
// Copyright (c) 2020 Krystian Stasiowski (sdkrystian@gmail.com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
//
// Official repository: https://github.com/boostorg/json
//
#ifndef BOOST_JSON_PARSE_HPP
#define BOOST_JSON_PARSE_HPP
#include <boost/json/detail/config.hpp>
#include <boost/json/error.hpp>
#include <boost/json/parse_options.hpp>
#include <boost/json/storage_ptr.hpp>
#include <boost/json/string_view.hpp>
#include <boost/json/value.hpp>
namespace boost {
namespace json {
/** Return parsed JSON as a @ref value.
This function parses an entire string in one
step to produce a complete JSON object, returned
as a @ref value. If the buffer does not contain a
complete serialized JSON, an error occurs. In this
case the returned value will be null, using the
[default memory resource].
@par Complexity
Linear in `s.size()`.
@par Exception Safety
Strong guarantee.
Calls to `memory_resource::allocate` may throw.
@return A value representing the parsed JSON,
or a null if any error occurred.
@param s The string to parse.
@param ec Set to the error, if any occurred.
@param sp The memory resource that the new value and all
of its elements will use. If this parameter is omitted,
the [default memory resource] is used.
@param opt The options for the parser. If this parameter
is omitted, the parser will accept only standard JSON.
@see
@ref parse_options,
@ref stream_parser.
[default memory resource]: json/allocators/storage_ptr.html#json.allocators.storage_ptr.default_memory_resource
*/
/** @{ */
BOOST_JSON_DECL
value
parse(
string_view s,
system::error_code& ec,
storage_ptr sp = {},
parse_options const& opt = {});
BOOST_JSON_DECL
value
parse(
string_view s,
std::error_code& ec,
storage_ptr sp = {},
parse_options const& opt = {});
/** @} */
/** Return parsed JSON as a @ref value.
This function parses an entire string in one
step to produce a complete JSON object, returned
as a @ref value. If the buffer does not contain a
complete serialized JSON, an exception is thrown.
@par Complexity
Linear in `s.size()`.
@par Exception Safety
Strong guarantee.
Calls to `memory_resource::allocate` may throw.
@return A value representing the parsed
JSON upon success.
@param s The string to parse.
@param sp The memory resource that the new value and all
of its elements will use. If this parameter is omitted,
the [default memory resource] is used.
@param opt The options for the parser. If this parameter
is omitted, the parser will accept only standard JSON.
@throw boost::system::system_error Thrown on failure.
@see
@ref parse_options,
@ref stream_parser.
[default memory resource]: json/allocators/storage_ptr.html#json.allocators.storage_ptr.default_memory_resource
*/
BOOST_JSON_DECL
value
parse(
string_view s,
storage_ptr sp = {},
parse_options const& opt = {});
/** Return parsed JSON as a @ref value.
This function reads data from an input stream and parses it to produce a
complete JSON entity, returned as a @ref value. If the stream does not
contain a complete serialized JSON, or contains extra non-whitespace data,
an error occurs. In this case the returned value will be `null`, using the
[default memory resource].
@par Complexity
Linear in the size of consumed input.
@par Exception Safety
Basic guarantee.
Calls to `memory_resource::allocate` may throw.
The stream may throw as described by
[`std::ios::exceptions`](https://en.cppreference.com/w/cpp/io/basic_ios/exceptions).
@return A value representing the parsed JSON,
or a `null` if any error occurred.
@param is The stream to read from.
@param ec Set to the error, if any occurred.
@param sp The memory resource that the new value and all of its elements
will use. If this parameter is omitted, the [default memory resource]
is used.
@param opt The options for the parser. If this parameter is omitted, the
parser will accept only standard JSON.
@see @ref parse_options, @ref stream_parser, @ref value::operator>>.
[default memory resource]: json/allocators/storage_ptr.html#json.allocators.storage_ptr.default_memory_resource
*/
/** @{ */
BOOST_JSON_DECL
value
parse(
std::istream& is,
system::error_code& ec,
storage_ptr sp = {},
parse_options const& opt = {});
BOOST_JSON_DECL
value
parse(
std::istream& is,
std::error_code& ec,
storage_ptr sp = {},
parse_options const& opt = {});
/** @} */
/** Return parsed JSON as a @ref value.
This function reads data from an input stream and parses it to produce a
complete JSON entity, returned as a @ref value. If the stream does not
contain a complete serialized JSON, or contains extra non-whitespace data,
an exception is thrown.
@par Complexity
Linear in the size of consumed input.
@par Exception Safety
Basic guarantee.
Throws `boost::system::system_error` on failed parse.
Calls to `memory_resource::allocate` may throw.
The stream may throw as described by
[`std::ios::exceptions`](https://en.cppreference.com/w/cpp/io/basic_ios/exceptions).
@return A value representing the parsed JSON upon success.
@param is The stream to read from.
@param sp The memory resource that the new value and all of its elements
will use. If this parameter is omitted, the [default memory resource]
is used.
@param opt The options for the parser. If this parameter is omitted, the
parser will accept only standard JSON.
@see @ref parse_options, @ref stream_parser, @ref value::operator>>.
[default memory resource]: json/allocators/storage_ptr.html#json.allocators.storage_ptr.default_memory_resource
*/
BOOST_JSON_DECL
value
parse(
std::istream& is,
storage_ptr sp = {},
parse_options const& opt = {});
} // namespace json
} // namespace boost
#endif