parse (3 of 6 overloads)

Return parsed JSON as a value.

Synopsis

Defined in header <boost/json/parse.hpp>

value
parse(
    std::istream& is,
    boost::system::error_code& ec,
    storage_ptr sp = {},
    parse_options const& opt = {});

This function reads data from an input stream and parses it to produce a complete JSON entity, returned as a 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.

Complexity

Linear in the size of consumed input.

Exception Safety

Basic guarantee. Calls to memory_resource::allocate may throw. The stream may throw as described by std::ios::exceptions.

Return Value

A value representing the parsed JSON, or a null if any error occurred.

Parameters

Name	Description
`is`	The stream to read from.
`ec`	Set to the error, if any occurred.
`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.
`opt`	The options for the parser. If this parameter is omitted, the parser will accept only standard JSON.

Boost C++ Libraries