Decode JSON from stream into value using options.

Synopsis

Declared in <baljsn_decoder.h>

template<class TYPE>
int
decode(
    std::istream& stream,
    TYPE* value,
    DecoderOptions const& options);

Description

Decode into the specified value, of a (template parameter) TYPE, the JSON data read from the specified stream and using the specified options. TYPE shall be a bdeat‐compatible sequence, choice, or array type, or a bdeat‐compatible dynamic type referring to one of those types. Specifying a nullptr options is equivalent to passing a default‐constructed DecoderOptions in options. Return 0 on success, and a non‐zero value otherwise. Note that this operation internally buffers input from stream, and if decoding is successful, will attempt to update the input position of stream to the last unprocessed byte.

Return Value

0 on success, and a non‐zero value otherwise

Parameters

Name

Description

stream

input stream supplying JSON

value

object to decode into

options

decoding options

Created with MrDocs