[#BloombergLP-bdljsn-ReadOptions]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdljsn.adoc[bdljsn]::ReadOptions
:relfileprefix: ../../
:mrdocs:

This simply constrained (value‐semantic) attribute class specifies options for reading a JSON document. See the  for information on the class attributes. Note that the class invariants are identically the constraints on the individual attributes.

== Synopsis

Declared in `<bdljsn_readoptions.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class ReadOptions;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/ReadOptions/2constructor-02.adoc[`ReadOptions`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdljsn/ReadOptions/2destructor.adoc[`~ReadOptions`] [.small]#[destructor]#
| Destroy this object.
| xref:BloombergLP/bdljsn/ReadOptions/operator_assign.adoc[`operator=`] 
| Assign to this object the value of the specified `rhs` object and return a non‐`const` reference to this object.
| xref:BloombergLP/bdljsn/ReadOptions/allowTrailingText.adoc[`allowTrailingText`] 
| Return the `allowTrailingText` attribute of this object.
| xref:BloombergLP/bdljsn/ReadOptions/maxNestedDepth.adoc[`maxNestedDepth`] 
| Return the `maxNestedDepth` attribute of this object.
| xref:BloombergLP/bdljsn/ReadOptions/print.adoc[`print`] 
| Format this object to the specified output `stream` at the optionally specified indentation `level` and return a reference to the modifiable `stream`. If `level` is specified, optionally specify `spacesPerLevel`, the number of spaces per indentation level for this and all of its nested objects. Each line is indented by the absolute value of `level * spacesPerLevel`. If `level` is negative, suppress indentation of the first line. If `spacesPerLevel` is negative, suppress line breaks and format the entire output on one line. If `stream` is initially invalid, this operation has no effect. Note that a trailing newline is provided in multiline mode only. Also note that the format is not fully specified, and can change without notice.
| xref:BloombergLP/bdljsn/ReadOptions/reset.adoc[`reset`] 
| Reset this object to the default value (i.e., its value upon default construction) and return a non‐`const` reference to this object.
| xref:BloombergLP/bdljsn/ReadOptions/setAllowTrailingText.adoc[`setAllowTrailingText`] 
| Set the `allowTrailingText` attribute of this object to th specified `value` and return a non‐`const` reference to this object.
| xref:BloombergLP/bdljsn/ReadOptions/setMaxNestedDepth.adoc[`setMaxNestedDepth`] 
| Set the `maxNestedDepth` attribute of this object to the specified `value` and return a non‐`const` reference to this object. The behavior is undefined unless `0 < value`.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/ReadOptions/s_DEFAULT_INITIALIZER_ALLOW_TRAILING_TEXT.adoc[`s_DEFAULT_INITIALIZER_ALLOW_TRAILING_TEXT`] 
| Default value for the `allowTrailingText` attribute.
| xref:BloombergLP/bdljsn/ReadOptions/s_DEFAULT_INITIALIZER_MAX_NESTED_DEPTH.adoc[`s_DEFAULT_INITIALIZER_MAX_NESTED_DEPTH`] 
| Default value for the `maxNestedDepth` attribute.
|===


== Non-Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdljsn/operator_not_eq-060.adoc[`operator!=`]
| Return `true` if the specified `lhs` and `rhs` attribute objects do not have the same value, and `false` otherwise. Two attribute objects do not have the same value if one or more respective attributes do not have the same value.
| xref:BloombergLP/bdljsn/operator_eq-063.adoc[`operator==`]
| Return `true` if the specified `lhs` and `rhs` attribute objects have the same value, and `false` otherwise. Two attribute objects have the same value if each respective attribute has the same value.
|===


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