Struct CommonFields

pub struct CommonFields<'a, F>
where
    F: IntoEnumIterator + Serialize + Debug,
{
    pub flags: FlagCollection<F>,
    pub ledger_entry_type: LedgerEntryType,
    pub index: Option<Cow<'a, str>>,
    pub ledger_index: Option<Cow<'a, str>>,
}

The base fields for all ledger object models.

See Ledger Object Common Fields: <https://xrpl.org/ledger-entry-common-fields.html>

Fields

flags: FlagCollection<F>

A bit-map of boolean flags enabled for this account.

ledger_entry_type: LedgerEntryType

The type of the ledger object.

index: Option<Cow<'a, str>>

The object ID of a single object to retrieve from the ledger, as a 64-character (256-bit) hexadecimal string.

ledger_index: Option<Cow<'a, str>>

The object ID in transaction metadata of a single object to retrieve from the ledger, as a 64-character (256-bit) hexadecimal string.

Implementations

impl<'a, F> CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug,

pub fn new( flags: FlagCollection<F>, ledger_entry_type: LedgerEntryType, index: Option<Cow<'a, str>>, ledger_index: Option<Cow<'a, str>>, ) -> Self

Constructs a new CommonFields.

Trait Implementations

impl<'a, F> Clone for CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug + Clone,

fn clone(&self) -> CommonFields<'a, F>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a, F> Debug for CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, 'a, F> Deserialize<'de> for CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, T> LedgerObject<T> for CommonFields<'a, T>

where T: IntoEnumIterator + Serialize + PartialEq + Debug,

fn has_flag(&self, flag: &T) -> bool

fn get_ledger_entry_type(&self) -> LedgerEntryType

impl<'a, F> PartialEq for CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug + PartialEq,

fn eq(&self, other: &CommonFields<'a, F>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, F> Serialize for CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, F> Eq for CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug + Eq,

impl<'a, F> StructuralPartialEq for CommonFields<'a, F>

where F: IntoEnumIterator + Serialize + Debug,