xrpld
Loading...
Searching...
No Matches
xrpl::ledger_entries::LedgerHashesBuilder Class Reference

Builder for LedgerHashes ledger entries. More...

#include <LedgerHashes.h>

Inheritance diagram for xrpl::ledger_entries::LedgerHashesBuilder:
Collaboration diagram for xrpl::ledger_entries::LedgerHashesBuilder:

Public Member Functions

 LedgerHashesBuilder (std::decay_t< typename SF_VECTOR256::type::value_type > const &hashes)
 Construct a new LedgerHashesBuilder with required fields.
 LedgerHashesBuilder (SLE::const_pointer sle)
 Construct a LedgerHashesBuilder from an existing SLE object.
LedgerHashesBuildersetFirstLedgerSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Ledger entry-specific field setters.
LedgerHashesBuildersetLastLedgerSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
 Set sfLastLedgerSequence (SoeOptional).
LedgerHashesBuildersetHashes (std::decay_t< typename SF_VECTOR256::type::value_type > const &value)
 Set sfHashes (SoeRequired).
LedgerHashes build (uint256 const &index)
 Build and return the completed LedgerHashes wrapper.
bool validate () const
 Validate the ledger entry.
LedgerHashesBuildersetLedgerIndex (uint256 const &value)
 Set the ledger index.
LedgerHashesBuildersetFlags (uint32_t value)
 Set the flags.

Protected Attributes

STObject object_

Detailed Description

Builder for LedgerHashes ledger entries.

Provides a fluent interface for constructing ledger entries with method chaining. Uses STObject internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 115 of file LedgerHashes.h.

Constructor & Destructor Documentation

◆ LedgerHashesBuilder() [1/2]

xrpl::ledger_entries::LedgerHashesBuilder::LedgerHashesBuilder ( std::decay_t< typename SF_VECTOR256::type::value_type > const & hashes)

Construct a new LedgerHashesBuilder with required fields.

Parameters
hashesThe sfHashes field value.

Definition at line 122 of file LedgerHashes.h.

◆ LedgerHashesBuilder() [2/2]

xrpl::ledger_entries::LedgerHashesBuilder::LedgerHashesBuilder ( SLE::const_pointer sle)

Construct a LedgerHashesBuilder from an existing SLE object.

Parameters
sleThe existing ledger entry to copy from.
Exceptions
std::runtime_errorif the ledger entry type doesn't match.

Definition at line 133 of file LedgerHashes.h.

Member Function Documentation

◆ setFirstLedgerSequence()

LedgerHashesBuilder & xrpl::ledger_entries::LedgerHashesBuilder::setFirstLedgerSequence ( std::decay_t< typename SF_UINT32::type::value_type > const & value)

Ledger entry-specific field setters.

Set sfFirstLedgerSequence (SoeOptional)

Returns
Reference to this builder for method chaining.

Definition at line 149 of file LedgerHashes.h.

◆ setLastLedgerSequence()

LedgerHashesBuilder & xrpl::ledger_entries::LedgerHashesBuilder::setLastLedgerSequence ( std::decay_t< typename SF_UINT32::type::value_type > const & value)

Set sfLastLedgerSequence (SoeOptional).

Returns
Reference to this builder for method chaining.

Definition at line 160 of file LedgerHashes.h.

◆ setHashes()

LedgerHashesBuilder & xrpl::ledger_entries::LedgerHashesBuilder::setHashes ( std::decay_t< typename SF_VECTOR256::type::value_type > const & value)

Set sfHashes (SoeRequired).

Returns
Reference to this builder for method chaining.

Definition at line 171 of file LedgerHashes.h.

◆ build()

LedgerHashes xrpl::ledger_entries::LedgerHashesBuilder::build ( uint256 const & index)

Build and return the completed LedgerHashes wrapper.

Parameters
indexThe ledger entry index.
Returns
The constructed ledger entry wrapper.

Definition at line 183 of file LedgerHashes.h.

◆ validate()

bool xrpl::ledger_entries::LedgerEntryBuilderBase< LedgerHashesBuilder >::validate ( ) const
nodiscardinherited

Validate the ledger entry.

Returns
true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

Set the ledger index.

Parameters
valueLedger index
Returns
Reference to the derived builder for method chaining.

Definition at line 62 of file LedgerEntryBuilderBase.h.

◆ setFlags()

Set the flags.

Parameters
valueFlags value
Returns
Reference to the derived builder for method chaining.

Definition at line 74 of file LedgerEntryBuilderBase.h.

Member Data Documentation

◆ object_

Definition at line 81 of file LedgerEntryBuilderBase.h.