#include <STValidation.h>

Inheritance diagram for ripple::STValidation:

[legend]

Collaboration diagram for ripple::STValidation:

[legend]

Public Types
using	iterator = boost::transform_iterator< Transform, STObject::list_type::const_iterator >

Public Member Functions
template<class LookupNodeID >
	STValidation (SerialIter &sit, LookupNodeID &&lookupNodeID, bool checkSignature)
	Construct a STValidation from a peer from serialized data. More...

template<typename F >
	STValidation (NetClock::time_point signTime, PublicKey const &pk, SecretKey const &sk, NodeID const &nodeID, F &&f)
	Construct, sign and trust a new STValidation issued by this node. More...

uint256	getLedgerHash () const

uint256	getConsensusHash () const

NetClock::time_point	getSignTime () const

NetClock::time_point	getSeenTime () const noexcept

PublicKey const &	getSignerPublic () const noexcept

NodeID const &	getNodeID () const noexcept

bool	isValid () const noexcept

bool	isFull () const noexcept

bool	isTrusted () const noexcept

uint256	getSigningHash () const

void	setTrusted ()

void	setUntrusted ()

void	setSeen (NetClock::time_point s)

Blob	getSerialized () const

Blob	getSignature () const

std::string	render () const

iterator	begin () const

iterator	end () const

bool	empty () const

void	reserve (std::size_t n)

void	applyTemplate (SOTemplate const &type)

void	applyTemplateFromSField (SField const &)

bool	isFree () const

void	set (SOTemplate const &)

bool	set (SerialIter &u, int depth=0)

void	set (std::unique_ptr< STBase > v)
	Set a field. More...

void	set (STBase &&v)

SerializedTypeID	getSType () const override

bool	isEquivalent (STBase const &t) const override

bool	isDefault () const override

void	add (Serializer &s) const override

std::string	getFullText () const override

std::string	getText () const override

Json::Value	getJson (JsonOptions=JsonOptions::none) const override

void	addWithoutSigningFields (Serializer &s) const

Serializer	getSerializer () const

template<class... Args>
std::size_t	emplace_back (Args &&... args)

int	getCount () const

bool	setFlag (std::uint32_t)

bool	clearFlag (std::uint32_t)

bool	isFlag (std::uint32_t) const

std::uint32_t	getFlags () const

uint256	getHash (HashPrefix prefix) const

uint256	getSigningHash (HashPrefix prefix) const

STBase const &	peekAtIndex (int offset) const

STBase &	getIndex (int offset)

STBase const *	peekAtPIndex (int offset) const

STBase *	getPIndex (int offset)

int	getFieldIndex (SField const &field) const

SField const &	getFieldSType (int index) const

STBase const &	peekAtField (SField const &field) const

STBase &	getField (SField const &field)

STBase const *	peekAtPField (SField const &field) const

STBase *	getPField (SField const &field, bool createOkay=false)

unsigned char	getFieldU8 (SField const &field) const

std::uint16_t	getFieldU16 (SField const &field) const

std::uint32_t	getFieldU32 (SField const &field) const

std::uint64_t	getFieldU64 (SField const &field) const

uint128	getFieldH128 (SField const &field) const

uint160	getFieldH160 (SField const &field) const

uint192	getFieldH192 (SField const &field) const

uint256	getFieldH256 (SField const &field) const

AccountID	getAccountID (SField const &field) const

Blob	getFieldVL (SField const &field) const

STAmount const &	getFieldAmount (SField const &field) const

STPathSet const &	getFieldPathSet (SField const &field) const

STVector256 const &	getFieldV256 (SField const &field) const

STArray const &	getFieldArray (SField const &field) const

STCurrency const &	getFieldCurrency (SField const &field) const

STNumber const &	getFieldNumber (SField const &field) const

template<class T >
T::value_type	operator[] (TypedField< T > const &f) const
	Get the value of a field. More...

template<class T >
std::optional< std::decay_t< typename T::value_type > >	operator[] (OptionaledField< T > const &of) const
	Get the value of a field as a std::optional. More...

template<class T >
ValueProxy< T >	operator[] (TypedField< T > const &f)
	Get a modifiable field value. More...

template<class T >
OptionalProxy< T >	operator[] (OptionaledField< T > const &of)
	Return a modifiable field value as std::optional. More...

template<class T >
auto	operator[] (TypedField< T > const &f) -> ValueProxy< T >

template<class T >
auto	operator[] (OptionaledField< T > const &of) -> OptionalProxy< T >

template<class T >
T::value_type	at (TypedField< T > const &f) const
	Get the value of a field. More...

template<class T >
std::optional< std::decay_t< typename T::value_type > >	at (OptionaledField< T > const &of) const
	Get the value of a field as std::optional. More...

template<class T >
ValueProxy< T >	at (TypedField< T > const &f)
	Get a modifiable field value. More...

template<class T >
OptionalProxy< T >	at (OptionaledField< T > const &of)
	Return a modifiable field value as std::optional. More...

template<class T >
auto	at (TypedField< T > const &f) -> ValueProxy< T >

template<class T >
auto	at (OptionaledField< T > const &of) -> OptionalProxy< T >

void	setFieldU8 (SField const &field, unsigned char)

void	setFieldU16 (SField const &field, std::uint16_t)

void	setFieldU32 (SField const &field, std::uint32_t)

void	setFieldU64 (SField const &field, std::uint64_t)

void	setFieldH128 (SField const &field, uint128 const &)

void	setFieldH256 (SField const &field, uint256 const &)

void	setFieldVL (SField const &field, Blob const &)

void	setFieldVL (SField const &field, Slice const &)

void	setAccountID (SField const &field, AccountID const &)

void	setFieldAmount (SField const &field, STAmount const &)

void	setFieldIssue (SField const &field, STIssue const &)

void	setFieldCurrency (SField const &field, STCurrency const &)

void	setFieldNumber (SField const &field, STNumber const &)

void	setFieldPathSet (SField const &field, STPathSet const &)

void	setFieldV256 (SField const &field, STVector256 const &v)

void	setFieldArray (SField const &field, STArray const &v)

template<class Tag >
void	setFieldH160 (SField const &field, base_uint< 160, Tag > const &v)

STObject &	peekFieldObject (SField const &field)

STArray &	peekFieldArray (SField const &field)

bool	isFieldPresent (SField const &field) const

STBase *	makeFieldPresent (SField const &field)

void	makeFieldAbsent (SField const &field)

bool	delField (SField const &field)

void	delField (int index)

bool	hasMatchingEntry (STBase const &)

bool	operator== (STObject const &o) const

bool	operator== (STBase const &t) const

bool	operator!= (STObject const &o) const

bool	operator!= (STBase const &t) const

template<typename T , typename V >
V	getFieldByValue (SField const &field) const

template<typename T , typename V >
V const &	getFieldByConstRef (SField const &field, V const &empty) const

template<class D >
D &	downcast ()

template<class D >
D const &	downcast () const

template<class D >
D const &	downcast () const

void	setFName (SField const &n)
	A STBase is a field. More...

SField const &	getFName () const

void	addFieldID (Serializer &s) const

Static Public Member Functions
static STObject	makeInnerObject (SField const &name)

Static Protected Member Functions
template<class T >
static STBase *	emplace (std::size_t n, void *buf, T &&val)

Private Types
enum	WhichFields : bool { omitSigningFields = false , withAllFields = true }

using	list_type = std::vector< detail::STVar >

Private Member Functions
STBase *	copy (std::size_t n, void *buf) const override

STBase *	move (std::size_t n, void *buf) override

void	add (Serializer &s, WhichFields whichFields) const

template<typename T , typename V = typename std::remove_cv<typename std::remove_reference< decltype(std::declval<T>().value())>::type, ::type >
V	getFieldByValue (SField const &field) const

template<typename T , typename V >
V const &	getFieldByConstRef (SField const &field, V const &empty) const

template<typename T , typename V >
void	setFieldUsingSetValue (SField const &field, V value)

template<typename T >
void	setFieldUsingAssignment (SField const &field, T const &value)

template<typename T >
T &	peekField (SField const &field)

Static Private Member Functions
static SOTemplate const &	validationFormat ()

static std::vector< STBase const * >	getSortedFields (STObject const &objToSort, WhichFields whichFields)

static auto &	getCounter () noexcept

Private Attributes
bool	mTrusted = false

std::optional< bool >	valid_

PublicKey const	signingPubKey_

NodeID const	nodeID_

NetClock::time_point	seenTime_ = {}

list_type	v_

SOTemplate const *	mType

SField const *	fName

Friends
class	detail::STVar

Detailed Description

Definition at line 46 of file STValidation.h.

Member Typedef Documentation

◆ list_type

using ripple::STObject::list_type = std::vector<detail::STVar>

privateinherited

Definition at line 77 of file STObject.h.

◆ iterator

using ripple::STObject::iterator = boost:: transform_iterator<Transform, STObject::list_type::const_iterator>

inherited

Definition at line 83 of file STObject.h.

Member Enumeration Documentation

◆ WhichFields

enum ripple::STObject::WhichFields : bool

privateinherited

Enumerator
omitSigningFields
withAllFields

Definition at line 421 of file STObject.h.

Constructor & Destructor Documentation

◆ STValidation() [1/2]

template<class LookupNodeID >

ripple::STValidation::STValidation	(	SerialIter &	sit,
		LookupNodeID &&	lookupNodeID,
		bool	checkSignature
	)

Construct a STValidation from a peer from serialized data.

Parameters

sit	Iterator over serialized data
lookupNodeID	Invocable with signature NodeID(PublicKey const&) used to find the Node ID based on the public key that signed the validation. For manifest based validators, this should be the NodeID of the master public key.
checkSignature	Whether to verify the data was signed properly

Note: Throws if the object is not valid

Definition at line 175 of file STValidation.h.

◆ STValidation() [2/2]

template<typename F >

ripple::STValidation::STValidation	(	NetClock::time_point	signTime,
		PublicKey const &	pk,
		SecretKey const &	sk,
		NodeID const &	nodeID,
		F &&	f
	)

Construct, sign and trust a new STValidation issued by this node.

Parameters

signTime	When the validation is signed
publicKey	The current signing public key
secretKey	The current signing secret key
nodeID	ID corresponding to node's public master key
f	callback function to "fill" the validation with necessary data

Definition at line 211 of file STValidation.h.

Member Function Documentation

◆ getLedgerHash()

uint256 ripple::STValidation::getLedgerHash ( ) const

Definition at line 94 of file STValidation.cpp.

◆ getConsensusHash()

uint256 ripple::STValidation::getConsensusHash ( ) const

Definition at line 100 of file STValidation.cpp.

◆ getSignTime()

NetClock::time_point ripple::STValidation::getSignTime ( ) const

Definition at line 106 of file STValidation.cpp.

◆ getSeenTime()

NetClock::time_point ripple::STValidation::getSeenTime ( ) const

noexcept

Definition at line 112 of file STValidation.cpp.

◆ getSignerPublic()

PublicKey const & ripple::STValidation::getSignerPublic ( ) const

noexcept

Definition at line 256 of file STValidation.h.

◆ getNodeID()

NodeID const & ripple::STValidation::getNodeID ( ) const

noexcept

Definition at line 262 of file STValidation.h.

◆ isValid()

bool ripple::STValidation::isValid ( ) const

noexcept

Definition at line 118 of file STValidation.cpp.

◆ isFull()

bool ripple::STValidation::isFull ( ) const

noexcept

Definition at line 137 of file STValidation.cpp.

◆ isTrusted()

bool ripple::STValidation::isTrusted ( ) const

noexcept

Definition at line 268 of file STValidation.h.

◆ getSigningHash() [1/2]

uint256 ripple::STValidation::getSigningHash ( ) const

Definition at line 88 of file STValidation.cpp.

◆ setTrusted()

void ripple::STValidation::setTrusted ( )

Definition at line 274 of file STValidation.h.

◆ setUntrusted()

void ripple::STValidation::setUntrusted ( )

Definition at line 280 of file STValidation.h.

◆ setSeen()

void ripple::STValidation::setSeen ( NetClock::time_point s )

Definition at line 286 of file STValidation.h.

◆ getSerialized()

Blob ripple::STValidation::getSerialized ( ) const

Definition at line 149 of file STValidation.cpp.

◆ getSignature()

Blob ripple::STValidation::getSignature ( ) const

Definition at line 143 of file STValidation.cpp.

◆ render()

std::string ripple::STValidation::render ( ) const

Definition at line 147 of file STValidation.h.

◆ validationFormat()

SOTemplate const & ripple::STValidation::validationFormat ( )

staticprivate

Definition at line 53 of file STValidation.cpp.

◆ copy()

STBase * ripple::STValidation::copy	(	std::size_t	n,
		void *	buf
	)		const

overrideprivatevirtual

Reimplemented from ripple::STObject.

Definition at line 41 of file STValidation.cpp.

◆ move()

STBase * ripple::STValidation::move	(	std::size_t	n,
		void *	buf
	)

overrideprivatevirtual

Reimplemented from ripple::STObject.

Definition at line 47 of file STValidation.cpp.

◆ makeInnerObject()

STObject ripple::STObject::makeInnerObject ( SField const & name )

staticinherited

Definition at line 95 of file STObject.cpp.

◆ begin()

STObject::iterator ripple::STObject::begin ( ) const

inherited

Definition at line 924 of file STObject.h.

◆ end()

STObject::iterator ripple::STObject::end ( ) const

inherited

Definition at line 930 of file STObject.h.

◆ empty()

bool ripple::STObject::empty ( ) const

inherited

Definition at line 936 of file STObject.h.

◆ reserve()

void ripple::STObject::reserve ( std::size_t n )

inherited

Definition at line 942 of file STObject.h.

◆ applyTemplate()

void ripple::STObject::applyTemplate ( SOTemplate const & type )

inherited

Definition at line 172 of file STObject.cpp.

◆ applyTemplateFromSField()

void ripple::STObject::applyTemplateFromSField ( SField const & sField )

inherited

Definition at line 226 of file STObject.cpp.

◆ isFree()

bool ripple::STObject::isFree ( ) const

inherited

Definition at line 948 of file STObject.h.

◆ set() [1/4]

void ripple::STObject::set ( SOTemplate const & type )

inherited

Definition at line 156 of file STObject.cpp.

◆ set() [2/4]

bool ripple::STObject::set	(	SerialIter &	u,
		int	depth = `0`
	)

inherited

Definition at line 236 of file STObject.cpp.

◆ set() [3/4]

void ripple::STObject::set ( std::unique_ptr< STBase > v )

inherited

Set a field.

if the field already exists, it is replaced.

Definition at line 707 of file STObject.cpp.

◆ set() [4/4]

void ripple::STObject::set ( STBase && v )

inherited

Definition at line 713 of file STObject.cpp.

◆ getSType()

SerializedTypeID ripple::STObject::getSType ( ) const

overridevirtualinherited

Reimplemented from ripple::STBase.

Reimplemented in ripple::STTx.

Definition at line 129 of file STObject.cpp.

◆ isEquivalent()

bool ripple::STObject::isEquivalent ( STBase const & t ) const

overridevirtualinherited

Reimplemented from ripple::STBase.

Definition at line 360 of file STObject.cpp.

◆ isDefault()

bool ripple::STObject::isDefault ( ) const

overridevirtualinherited

Reimplemented from ripple::STBase.

Definition at line 135 of file STObject.cpp.

◆ add() [1/2]

void ripple::STObject::add ( Serializer & s ) const

overridevirtualinherited

Reimplemented from ripple::STBase.

Definition at line 141 of file STObject.cpp.

◆ add() [2/2]

void ripple::STObject::add	(	Serializer &	s,
		WhichFields	whichFields
	)		const

privateinherited

Definition at line 881 of file STObject.cpp.

◆ getFullText()

std::string ripple::STObject::getFullText ( ) const

overridevirtualinherited

Reimplemented from ripple::STBase.

Reimplemented in ripple::STTx.

Definition at line 310 of file STObject.cpp.

◆ getText()

std::string ripple::STObject::getText ( ) const

overridevirtualinherited

Reimplemented from ripple::STBase.

Definition at line 341 of file STObject.cpp.

◆ getJson()

Json::Value ripple::STObject::getJson ( JsonOptions options = JsonOptions::none ) const

overridevirtualinherited

Reimplemented from ripple::STBase.

Reimplemented in ripple::STTx.

Definition at line 825 of file STObject.cpp.

◆ addWithoutSigningFields()

void ripple::STObject::addWithoutSigningFields ( Serializer & s ) const

inherited

Definition at line 954 of file STObject.h.

◆ getSerializer()

Serializer ripple::STObject::getSerializer ( ) const

inherited

Definition at line 963 of file STObject.h.

◆ emplace_back()

template<class... Args>

std::size_t ripple::STObject::emplace_back ( Args &&... args )

inherited

Definition at line 972 of file STObject.h.

◆ getCount()

int ripple::STObject::getCount ( ) const

inherited

Definition at line 979 of file STObject.h.

◆ setFlag()

bool ripple::STObject::setFlag ( std::uint32_t f )

inherited

Definition at line 507 of file STObject.cpp.

◆ clearFlag()

bool ripple::STObject::clearFlag ( std::uint32_t f )

inherited

Definition at line 519 of file STObject.cpp.

◆ isFlag()

bool ripple::STObject::isFlag ( std::uint32_t f ) const

inherited

Definition at line 531 of file STObject.cpp.

◆ getFlags()

std::uint32_t ripple::STObject::getFlags ( void ) const

inherited

Definition at line 537 of file STObject.cpp.

◆ getHash()

uint256 ripple::STObject::getHash ( HashPrefix prefix ) const

inherited

Definition at line 395 of file STObject.cpp.

◆ getSigningHash() [2/2]

uint256 ripple::STObject::getSigningHash ( HashPrefix prefix ) const

inherited

Definition at line 404 of file STObject.cpp.

◆ peekAtIndex()

STBase const & ripple::STObject::peekAtIndex ( int offset ) const

inherited

Definition at line 985 of file STObject.h.

◆ getIndex()

STBase & ripple::STObject::getIndex ( int offset )

inherited

Definition at line 991 of file STObject.h.

◆ peekAtPIndex()

STBase const * ripple::STObject::peekAtPIndex ( int offset ) const

inherited

Definition at line 997 of file STObject.h.

◆ getPIndex()

STBase * ripple::STObject::getPIndex ( int offset )

inherited

Definition at line 1003 of file STObject.h.

◆ getFieldIndex()

int ripple::STObject::getFieldIndex ( SField const & field ) const

inherited

Definition at line 413 of file STObject.cpp.

◆ getFieldSType()

SField const & ripple::STObject::getFieldSType ( int index ) const

inherited

Definition at line 451 of file STObject.cpp.

◆ peekAtField()

STBase const & ripple::STObject::peekAtField ( SField const & field ) const

inherited

Definition at line 429 of file STObject.cpp.

◆ getField()

STBase & ripple::STObject::getField ( SField const & field )

inherited

Definition at line 440 of file STObject.cpp.

◆ peekAtPField()

STBase const * ripple::STObject::peekAtPField ( SField const & field ) const

inherited

Definition at line 457 of file STObject.cpp.

◆ getPField()

STBase * ripple::STObject::getPField	(	SField const &	field,
		bool	createOkay = `false`
	)

inherited

Definition at line 468 of file STObject.cpp.

◆ getFieldU8()

unsigned char ripple::STObject::getFieldU8 ( SField const & field ) const

inherited

Definition at line 603 of file STObject.cpp.

◆ getFieldU16()

std::uint16_t ripple::STObject::getFieldU16 ( SField const & field ) const

inherited

Definition at line 609 of file STObject.cpp.

◆ getFieldU32()

std::uint32_t ripple::STObject::getFieldU32 ( SField const & field ) const

inherited

Definition at line 615 of file STObject.cpp.

◆ getFieldU64()

std::uint64_t ripple::STObject::getFieldU64 ( SField const & field ) const

inherited

Definition at line 621 of file STObject.cpp.

◆ getFieldH128()

uint128 ripple::STObject::getFieldH128 ( SField const & field ) const

inherited

Definition at line 627 of file STObject.cpp.

◆ getFieldH160()

uint160 ripple::STObject::getFieldH160 ( SField const & field ) const

inherited

Definition at line 633 of file STObject.cpp.

◆ getFieldH192()

uint192 ripple::STObject::getFieldH192 ( SField const & field ) const

inherited

Definition at line 639 of file STObject.cpp.

◆ getFieldH256()

uint256 ripple::STObject::getFieldH256 ( SField const & field ) const

inherited

Definition at line 645 of file STObject.cpp.

◆ getAccountID()

AccountID ripple::STObject::getAccountID ( SField const & field ) const

inherited

Definition at line 651 of file STObject.cpp.

◆ getFieldVL()

Blob ripple::STObject::getFieldVL ( SField const & field ) const

inherited

Definition at line 657 of file STObject.cpp.

◆ getFieldAmount()

STAmount const & ripple::STObject::getFieldAmount ( SField const & field ) const

inherited

Definition at line 665 of file STObject.cpp.

◆ getFieldPathSet()

STPathSet const & ripple::STObject::getFieldPathSet ( SField const & field ) const

inherited

Definition at line 672 of file STObject.cpp.

◆ getFieldV256()

STVector256 const & ripple::STObject::getFieldV256 ( SField const & field ) const

inherited

Definition at line 679 of file STObject.cpp.

◆ getFieldArray()

STArray const & ripple::STObject::getFieldArray ( SField const & field ) const

inherited

Definition at line 686 of file STObject.cpp.

◆ getFieldCurrency()

STCurrency const & ripple::STObject::getFieldCurrency ( SField const & field ) const

inherited

Definition at line 693 of file STObject.cpp.

◆ getFieldNumber()

STNumber const & ripple::STObject::getFieldNumber ( SField const & field ) const

inherited

Definition at line 700 of file STObject.cpp.

◆ operator[]() [1/6]

template<class T >

T::value_type ripple::STObject::operator[] ( TypedField< T > const & f ) const

inherited

Get the value of a field.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: The value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

Definition at line 1010 of file STObject.h.

◆ operator[]() [2/6]

template<class T >

std::optional< std::decay_t< typename T::value_type > > ripple::STObject::operator[] ( OptionaledField< T > const & of ) const

inherited

Get the value of a field as a std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: std::nullopt if the field is not present, else the value of the specified field.

Definition at line 1017 of file STObject.h.

◆ operator[]() [3/6]

template<class T >

ValueProxy< T > ripple::STObject::operator[] ( TypedField< T > const & f )

inherited

Get a modifiable field value.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: A modifiable reference to the value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

◆ operator[]() [4/6]

template<class T >

OptionalProxy< T > ripple::STObject::operator[] ( OptionaledField< T > const & of )

inherited

Return a modifiable field value as std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: Transparent proxy object to an optional holding a modifiable reference to the value of the specified field. Returns std::nullopt if the field is not present.

◆ operator[]() [5/6]

template<class T >

auto ripple::STObject::operator[] ( TypedField< T > const & f ) -> ValueProxy<T>

inherited

Definition at line 1024 of file STObject.h.

◆ operator[]() [6/6]

template<class T >

auto ripple::STObject::operator[] ( OptionaledField< T > const & of ) -> OptionalProxy<T>

inherited

Definition at line 1031 of file STObject.h.

◆ at() [1/6]

template<class T >

T::value_type ripple::STObject::at ( TypedField< T > const & f ) const

inherited

Get the value of a field.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: The value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

Definition at line 1038 of file STObject.h.

◆ at() [2/6]

template<class T >

std::optional< std::decay_t< typename T::value_type > > ripple::STObject::at ( OptionaledField< T > const & of ) const

inherited

Get the value of a field as std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: std::nullopt if the field is not present, else the value of the specified field.

Definition at line 1071 of file STObject.h.

◆ at() [3/6]

template<class T >

ValueProxy< T > ripple::STObject::at ( TypedField< T > const & f )

inherited

Get a modifiable field value.

Parameters

A	TypedField built from an SField value representing the desired object field. In typical use, the TypedField will be implicitly constructed.

Returns: A modifiable reference to the value of the specified field.

Exceptions

STObject::FieldErr if the field is not present.

◆ at() [4/6]

template<class T >

OptionalProxy< T > ripple::STObject::at ( OptionaledField< T > const & of )

inherited

Return a modifiable field value as std::optional.

Parameters

An	OptionaledField built from an SField value representing the desired object field. In typical use, the OptionaledField will be constructed by using the ~ operator on an SField.

Returns: Transparent proxy object to an optional holding a modifiable reference to the value of the specified field. Returns std::nullopt if the field is not present.

◆ at() [5/6]

template<class T >

auto ripple::STObject::at ( TypedField< T > const & f ) -> ValueProxy<T>

inherited

Definition at line 1099 of file STObject.h.

◆ at() [6/6]

template<class T >

auto ripple::STObject::at ( OptionaledField< T > const & of ) -> OptionalProxy<T>

inherited

Definition at line 1106 of file STObject.h.

◆ setFieldU8()

void ripple::STObject::setFieldU8	(	SField const &	field,
		unsigned char	v
	)

inherited

Definition at line 729 of file STObject.cpp.

◆ setFieldU16()

void ripple::STObject::setFieldU16	(	SField const &	field,
		std::uint16_t	v
	)

inherited

Definition at line 735 of file STObject.cpp.

◆ setFieldU32()

void ripple::STObject::setFieldU32	(	SField const &	field,
		std::uint32_t	v
	)

inherited

Definition at line 741 of file STObject.cpp.

◆ setFieldU64()

void ripple::STObject::setFieldU64	(	SField const &	field,
		std::uint64_t	v
	)

inherited

Definition at line 747 of file STObject.cpp.

◆ setFieldH128()

void ripple::STObject::setFieldH128	(	SField const &	field,
		uint128 const &	v
	)

inherited

Definition at line 753 of file STObject.cpp.

◆ setFieldH256()

void ripple::STObject::setFieldH256	(	SField const &	field,
		uint256 const &	v
	)

inherited

Definition at line 759 of file STObject.cpp.

◆ setFieldVL() [1/2]

void ripple::STObject::setFieldVL	(	SField const &	field,
		Blob const &	v
	)

inherited

Definition at line 777 of file STObject.cpp.

◆ setFieldVL() [2/2]

void ripple::STObject::setFieldVL	(	SField const &	field,
		Slice const &	s
	)

inherited

Definition at line 783 of file STObject.cpp.

◆ setAccountID()

void ripple::STObject::setAccountID	(	SField const &	field,
		AccountID const &	v
	)

inherited

Definition at line 771 of file STObject.cpp.

◆ setFieldAmount()

void ripple::STObject::setFieldAmount	(	SField const &	field,
		STAmount const &	v
	)

inherited

Definition at line 789 of file STObject.cpp.

◆ setFieldIssue()

void ripple::STObject::setFieldIssue	(	SField const &	field,
		STIssue const &	v
	)

inherited

Definition at line 801 of file STObject.cpp.

◆ setFieldCurrency()

void ripple::STObject::setFieldCurrency	(	SField const &	field,
		STCurrency const &	v
	)

inherited

Definition at line 795 of file STObject.cpp.

◆ setFieldNumber()

void ripple::STObject::setFieldNumber	(	SField const &	field,
		STNumber const &	v
	)

inherited

Definition at line 807 of file STObject.cpp.

◆ setFieldPathSet()

void ripple::STObject::setFieldPathSet	(	SField const &	field,
		STPathSet const &	v
	)

inherited

Definition at line 813 of file STObject.cpp.

◆ setFieldV256()

void ripple::STObject::setFieldV256	(	SField const &	field,
		STVector256 const &	v
	)

inherited

Definition at line 765 of file STObject.cpp.

◆ setFieldArray()

void ripple::STObject::setFieldArray	(	SField const &	field,
		STArray const &	v
	)

inherited

Definition at line 819 of file STObject.cpp.

◆ setFieldH160()

template<class Tag >

void ripple::STObject::setFieldH160	(	SField const &	field,
		base_uint< 160, Tag > const &	v
	)

inherited

Definition at line 1113 of file STObject.h.

◆ peekFieldObject()

STObject & ripple::STObject::peekFieldObject ( SField const & field )

inherited

Definition at line 495 of file STObject.cpp.

◆ peekFieldArray()

STArray & ripple::STObject::peekFieldArray ( SField const & field )

inherited

Definition at line 501 of file STObject.cpp.

◆ isFieldPresent()

bool ripple::STObject::isFieldPresent ( SField const & field ) const

inherited

Definition at line 484 of file STObject.cpp.

◆ makeFieldPresent()

STBase * ripple::STObject::makeFieldPresent ( SField const & field )

inherited

Definition at line 548 of file STObject.cpp.

◆ makeFieldAbsent()

void ripple::STObject::makeFieldAbsent ( SField const & field )

inherited

Definition at line 570 of file STObject.cpp.

◆ delField() [1/2]

bool ripple::STObject::delField ( SField const & field )

inherited

Definition at line 585 of file STObject.cpp.

◆ delField() [2/2]

void ripple::STObject::delField ( int index )

inherited

Definition at line 597 of file STObject.cpp.

◆ hasMatchingEntry()

bool ripple::STObject::hasMatchingEntry ( STBase const & t )

inherited

Definition at line 299 of file STObject.cpp.

◆ operator==() [1/2]

bool ripple::STObject::operator== ( STObject const & o ) const

inherited

Definition at line 838 of file STObject.cpp.

◆ operator==() [2/2]

bool ripple::STBase::operator== ( STBase const & t ) const

inherited

Definition at line 51 of file STBase.cpp.

◆ operator!=() [1/2]

bool ripple::STObject::operator!= ( STObject const & o ) const

inherited

Definition at line 1131 of file STObject.h.

◆ operator!=() [2/2]

bool ripple::STBase::operator!= ( STBase const & t ) const

inherited

Definition at line 57 of file STBase.cpp.

◆ getSortedFields()

std::vector< STBase const * > ripple::STObject::getSortedFields	(	STObject const &	objToSort,
		WhichFields	whichFields
	)

staticprivateinherited

Definition at line 907 of file STObject.cpp.

◆ getFieldByValue() [1/2]

template<typename T , typename V = typename std::remove_cv<typename std::remove_reference< decltype(std::declval<T>().value())>::type, ::type >

V ripple::STObject::getFieldByValue ( SField const & field ) const

privateinherited

◆ getFieldByValue() [2/2]

template<typename T , typename V >

V ripple::STObject::getFieldByValue ( SField const & field ) const

inherited

Definition at line 1138 of file STObject.h.

◆ getFieldByConstRef() [1/2]

template<typename T , typename V >

V const & ripple::STObject::getFieldByConstRef	(	SField const &	field,
		V const &	empty
	)		const

privateinherited

◆ getFieldByConstRef() [2/2]

template<typename T , typename V >

V const & ripple::STObject::getFieldByConstRef	(	SField const &	field,
		V const &	empty
	)		const

inherited

Definition at line 1165 of file STObject.h.

◆ setFieldUsingSetValue()

template<typename T , typename V >

void ripple::STObject::setFieldUsingSetValue	(	SField const &	field,
		V	value
	)

privateinherited

Definition at line 1188 of file STObject.h.

◆ setFieldUsingAssignment()

template<typename T >

void ripple::STObject::setFieldUsingAssignment	(	SField const &	field,
		T const &	value
	)

privateinherited

Definition at line 1211 of file STObject.h.

◆ peekField()

template<typename T >

T & ripple::STObject::peekField ( SField const & field )

privateinherited

Definition at line 1232 of file STObject.h.

◆ downcast() [1/3]

template<class D >

D & ripple::STBase::downcast

inherited

Definition at line 214 of file STBase.h.

◆ downcast() [2/3]

template<class D >

D const & ripple::STBase::downcast ( ) const

inherited

◆ downcast() [3/3]

template<class D >

D const & ripple::STBase::downcast ( ) const

inherited

Definition at line 224 of file STBase.h.

◆ setFName()

void ripple::STBase::setFName ( SField const & n )

inherited

A STBase is a field.

This sets the name.

Definition at line 134 of file STBase.cpp.

◆ getFName()

SField const & ripple::STBase::getFName ( ) const

inherited

Definition at line 141 of file STBase.cpp.

◆ addFieldID()

void ripple::STBase::addFieldID ( Serializer & s ) const

inherited

Definition at line 147 of file STBase.cpp.

◆ emplace()

template<class T >

STBase * ripple::STBase::emplace	(	std::size_t	n,
		void *	buf,
		T &&	val
	)

staticprotectedinherited

Definition at line 234 of file STBase.h.

◆ getCounter()

static auto & ripple::CountedObject< STObject >::getCounter ( )

staticprivatenoexceptinherited

Definition at line 129 of file CountedObject.h.

Friends And Related Function Documentation

◆ detail::STVar

friend class detail::STVar

friend

Definition at line 171 of file STValidation.h.

Member Data Documentation

◆ mTrusted

bool ripple::STValidation::mTrusted = false

private

Definition at line 48 of file STValidation.h.

◆ valid_

std::optional<bool> ripple::STValidation::valid_

mutableprivate

Definition at line 52 of file STValidation.h.

◆ signingPubKey_

PublicKey const ripple::STValidation::signingPubKey_

private

Definition at line 55 of file STValidation.h.

◆ nodeID_

NodeID const ripple::STValidation::nodeID_

private

Definition at line 59 of file STValidation.h.

◆ seenTime_

NetClock::time_point ripple::STValidation::seenTime_ = {}

private

Definition at line 61 of file STValidation.h.

◆ v_

list_type ripple::STObject::v_

privateinherited

Definition at line 79 of file STObject.h.

◆ mType

SOTemplate const* ripple::STObject::mType

privateinherited

Definition at line 80 of file STObject.h.

◆ fName

SField const* ripple::STBase::fName

privateinherited

Definition at line 137 of file STBase.h.

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ list_type

◆ iterator

Member Enumeration Documentation

◆ WhichFields

Constructor & Destructor Documentation

◆ STValidation() [1/2]

◆ STValidation() [2/2]

Member Function Documentation

◆ getLedgerHash()

◆ getConsensusHash()

◆ getSignTime()

◆ getSeenTime()

◆ getSignerPublic()

◆ getNodeID()

◆ isValid()

◆ isFull()

◆ isTrusted()

◆ getSigningHash() [1/2]

◆ setTrusted()

◆ setUntrusted()

◆ setSeen()

◆ getSerialized()

◆ getSignature()

◆ render()

◆ validationFormat()

◆ copy()

◆ move()

◆ makeInnerObject()

◆ begin()

◆ end()

◆ empty()

◆ reserve()

◆ applyTemplate()

◆ applyTemplateFromSField()

◆ isFree()

◆ set() [1/4]

◆ set() [2/4]

◆ set() [3/4]

◆ set() [4/4]

◆ getSType()

◆ isEquivalent()

◆ isDefault()

◆ add() [1/2]

◆ add() [2/2]

◆ getFullText()

◆ getText()

◆ getJson()

◆ addWithoutSigningFields()

◆ getSerializer()

◆ emplace_back()

◆ getCount()

◆ setFlag()

◆ clearFlag()

◆ isFlag()

◆ getFlags()

◆ getHash()

◆ getSigningHash() [2/2]

◆ peekAtIndex()

◆ getIndex()

◆ peekAtPIndex()

◆ getPIndex()

◆ getFieldIndex()

◆ getFieldSType()

◆ peekAtField()

◆ getField()

◆ peekAtPField()

◆ getPField()

◆ getFieldU8()

◆ getFieldU16()