[#BloombergLP-bdljsn-JsonUtil-read-02c]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdljsn.adoc[bdljsn]::xref:BloombergLP/bdljsn/JsonUtil.adoc[JsonUtil]::read
:relfileprefix: ../../../
:mrdocs:

`read` overloads

== Synopses

Declared in `<bdljsn_jsonutil.h>`

Load to the specified `result` a value‐semantic representation of the JSON text in the specified `input`. Optionally specify an `errorDescription` that, if an error occurs, is loaded with a description of the error. Optionally specify `options` which allow altering the maximum nesting depth. Return 0 on success, and a non‐zero value if `input` does not consist of valid JSON text or an error occurs when reading from `input`. If `options.allowTrailingText()` is `false` (the default), then an error will be reported if a valid JSON text is followed by any text that does not consist solely of white‐space characters. If `options.allowTrailingText()` is `true`, then this function will return success where a valid JSON document is followed by additional text as long as that text is separated from the valid JSON by a delimiter character (i.e., either the JSON text ends in a delimiter, or the text that follows starts with a delimiter). Here, delimiters are white‐space characters, `[]`,`]`,`{`,`}`,`,`, or `"`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-0b7.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    std::istream& input);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-0b7.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-06d.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    std::string_view const& input);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-06d.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-0e1.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    std::streambuf* input);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-0e1.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-0f.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    std::istream& input,
    xref:BloombergLP/bdljsn/ReadOptions.adoc[ReadOptions] const& options);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-0f.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-066.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    std::string_view const& input,
    xref:BloombergLP/bdljsn/ReadOptions.adoc[ReadOptions] const& options);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-066.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-0e4.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    xref:BloombergLP/bdljsn/Error.adoc[Error]* errorDescription,
    std::istream& input);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-0e4.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-00a.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    xref:BloombergLP/bdljsn/Error.adoc[Error]* errorDescription,
    std::string_view const& input);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-00a.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-0b0.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    xref:BloombergLP/bdljsn/Error.adoc[Error]* errorDescription,
    std::streambuf* input);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-0b0.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-006.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    std::streambuf* input,
    xref:BloombergLP/bdljsn/ReadOptions.adoc[ReadOptions] const& options);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-006.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-07.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    xref:BloombergLP/bdljsn/Error.adoc[Error]* errorDescription,
    std::istream& input,
    xref:BloombergLP/bdljsn/ReadOptions.adoc[ReadOptions] const& options);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-07.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-0b6.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    xref:BloombergLP/bdljsn/Error.adoc[Error]* errorDescription,
    std::string_view const& input,
    xref:BloombergLP/bdljsn/ReadOptions.adoc[ReadOptions] const& options);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-0b6.adoc[_» more..._]#

Load into `result` a value‐semantic representation of the JSON text in `input`. Return 0 on success and a non‐zero value otherwise. See the first `read` overload for full contract details.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
xref:BloombergLP/bdljsn/JsonUtil/read-02d.adoc[read](
    xref:BloombergLP/bdljsn/Json.adoc[Json]* result,
    xref:BloombergLP/bdljsn/Error.adoc[Error]* errorDescription,
    std::streambuf* input,
    xref:BloombergLP/bdljsn/ReadOptions.adoc[ReadOptions] const& options);
----

[.small]#xref:BloombergLP/bdljsn/JsonUtil/read-02d.adoc[_» more..._]#


[.small]#Created with https://www.mrdocs.com[MrDocs]#