rippled
Public Member Functions | Public Attributes | List of all members
ripple::STParsedJSONObject Class Reference

Holds the serialized result of parsing an input JSON object. More...

Collaboration diagram for ripple::STParsedJSONObject:
Collaboration graph
[legend]

Public Member Functions

 STParsedJSONObject (std::string const &name, Json::Value const &json)
 Parses and creates an STParsedJSON object. More...
 
 STParsedJSONObject ()=delete
 
 STParsedJSONObject (STParsedJSONObject const &)=delete
 
STParsedJSONObjectoperator= (STParsedJSONObject const &)=delete
 
 ~STParsedJSONObject ()=default
 

Public Attributes

std::optional< STObjectobject
 The STObject if the parse was successful. More...
 
Json::Value error
 On failure, an appropriate set of error values. More...
 

Detailed Description

Holds the serialized result of parsing an input JSON object.

This does validation and checking on the provided JSON.

Definition at line 31 of file STParsedJSON.h.

Constructor & Destructor Documentation

◆ STParsedJSONObject() [1/3]

ripple::STParsedJSONObject::STParsedJSONObject ( std::string const &  name,
Json::Value const &  json 
)

Parses and creates an STParsedJSON object.

The result of the parsing is stored in object and error. Exceptions: Does not throw.

Parameters
nameThe name of the JSON field, used in diagnostics.
jsonThe JSON-RPC to parse.

Definition at line 962 of file STParsedJSON.cpp.

◆ STParsedJSONObject() [2/3]

ripple::STParsedJSONObject::STParsedJSONObject ( )
delete

◆ STParsedJSONObject() [3/3]

ripple::STParsedJSONObject::STParsedJSONObject ( STParsedJSONObject const &  )
delete

◆ ~STParsedJSONObject()

ripple::STParsedJSONObject::~STParsedJSONObject ( )
default

Member Function Documentation

◆ operator=()

STParsedJSONObject& ripple::STParsedJSONObject::operator= ( STParsedJSONObject const &  )
delete

Member Data Documentation

◆ object

std::optional<STObject> ripple::STParsedJSONObject::object

The STObject if the parse was successful.

Definition at line 50 of file STParsedJSON.h.

◆ error

Json::Value ripple::STParsedJSONObject::error

On failure, an appropriate set of error values.

Definition at line 53 of file STParsedJSON.h.