xrpl::ledger_entries::LedgerEntryBase Class Reference

Base class for type-safe ledger entry wrappers. More...

#include <LedgerEntryBase.h>

Inheritance diagram for xrpl::ledger_entries::LedgerEntryBase:

Collaboration diagram for xrpl::ledger_entries::LedgerEntryBase:

Public Member Functions
	LedgerEntryBase (SLE::const_pointer sle)
	Construct a ledger entry wrapper from an existing SLE object.
bool	validate () const
	Validate the ledger entry.
LedgerEntryType	getType () const
	Get the ledger entry type.
uint256 const &	getKey () const
	Get the key (index) of this ledger entry.
std::optional< uint256 >	getLedgerIndex () const
	Get the ledger index (sfLedgerIndex).
bool	hasLedgerIndex () const
	Check if the ledger entry has a ledger index.
uint16_t	getLedgerEntryType () const
	Get the ledger entry type field (sfLedgerEntryType).
std::uint32_t	getFlags () const
	Get the flags field (sfFlags).
bool	isFlag (std::uint32_t f) const
	Check if a specific flag is set.
SLE::const_pointer	getSle () const
	Get the underlying SLE object.

Protected Attributes
SLE::const_pointer	sle_
	The underlying serialized ledger entry being wrapped.

Detailed Description

Base class for type-safe ledger entry wrappers.

This class provides common functionality for all ledger entry types, including access to common fields (sfLedgerIndex, sfLedgerEntryType, sfFlags).

This is an immutable wrapper around SLE (Serialized Ledger Entry). Use the corresponding Builder classes to construct new ledger entries.

Definition at line 23 of file LedgerEntryBase.h.

Constructor & Destructor Documentation

LedgerEntryBase()

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

explicit

Construct a ledger entry wrapper from an existing SLE object.

Parameters

sle	The underlying serialized ledger entry to wrap

Definition at line 30 of file LedgerEntryBase.h.

Member Function Documentation

validate()

bool xrpl::ledger_entries::LedgerEntryBase::validate ( ) const

nodiscard

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 40 of file LedgerEntryBase.h.

getType()

LedgerEntryType xrpl::ledger_entries::LedgerEntryBase::getType ( ) const

nodiscard

Get the ledger entry type.

Returns

The type of this ledger entry

Definition at line 57 of file LedgerEntryBase.h.

getKey()

uint256 const & xrpl::ledger_entries::LedgerEntryBase::getKey ( ) const

nodiscard

Get the key (index) of this ledger entry.

The key uniquely identifies this ledger entry in the ledger state.

Returns

A constant reference to the 256-bit key

Definition at line 70 of file LedgerEntryBase.h.

getLedgerIndex()

std::optional< uint256 > xrpl::ledger_entries::LedgerEntryBase::getLedgerIndex ( ) const

nodiscard

Get the ledger index (sfLedgerIndex).

This field is OPTIONAL and represents the index of the ledger entry.

Returns

The ledger index if present, std::nullopt otherwise

Definition at line 85 of file LedgerEntryBase.h.

hasLedgerIndex()

bool xrpl::ledger_entries::LedgerEntryBase::hasLedgerIndex ( ) const

nodiscard

Check if the ledger entry has a ledger index.

Returns

true if sfLedgerIndex is present, false otherwise

Definition at line 100 of file LedgerEntryBase.h.

getLedgerEntryType()

uint16_t xrpl::ledger_entries::LedgerEntryBase::getLedgerEntryType ( ) const

nodiscard

Get the ledger entry type field (sfLedgerEntryType).

This field is REQUIRED for all ledger entries and indicates the type of the ledger entry (e.g., AccountRoot, RippleState, Offer, etc.).

Returns

The ledger entry type as a 16-bit unsigned integer

Definition at line 114 of file LedgerEntryBase.h.

getFlags()

std::uint32_t xrpl::ledger_entries::LedgerEntryBase::getFlags ( ) const

nodiscard

Get the flags field (sfFlags).

This field is REQUIRED for all ledger entries and contains type-specific flags that modify the behavior of the ledger entry.

Returns

The flags value as a 32-bit unsigned integer

Definition at line 128 of file LedgerEntryBase.h.

isFlag()

bool xrpl::ledger_entries::LedgerEntryBase::isFlag ( std::uint32_t f ) const

nodiscard

Check if a specific flag is set.

Parameters

f	The flag bitmask to check

Returns

true if all bits in f are set in the flags field

Definition at line 141 of file LedgerEntryBase.h.

getSle()

SLE::const_pointer xrpl::ledger_entries::LedgerEntryBase::getSle ( ) const

nodiscard

Get the underlying SLE object.

Provides direct access to the wrapped serialized ledger entry object for cases where the type-safe accessors are insufficient.

Returns

A constant reference to the underlying SLE object

Definition at line 155 of file LedgerEntryBase.h.

Member Data Documentation

sle_

SLE::const_pointer xrpl::ledger_entries::LedgerEntryBase::sle_

protected

The underlying serialized ledger entry being wrapped.

Definition at line 162 of file LedgerEntryBase.h.