Struct DirectoryNode

pub struct DirectoryNode<'a> {
    pub common_fields: CommonFields<'a, NoFlags>,
    pub exchange_rate: Option<Cow<'a, str>>,
    pub indexes: Vec<Cow<'a, str>>,
    pub root_index: Cow<'a, str>,
    pub index_next: Option<u64>,
    pub index_previous: Option<u64>,
    pub owner: Option<Cow<'a, str>>,
    pub taker_gets_currency: Option<Cow<'a, str>>,
    pub taker_gets_issuer: Option<Cow<'a, str>>,
    pub taker_pays_currency: Option<Cow<'a, str>>,
    pub taker_pays_issuer: Option<Cow<'a, str>>,
}

The DirectoryNode object type provides a list of links to other objects in the ledger’s state tree. A single conceptual Directory　takes the form of a doubly linked list, with one or more DirectoryNode objects each containing up to 32 IDs of other objects. The first object is called the root of the directory, and all objects other than the root object can be added or deleted as necessary.

There are two kinds of Directories:

• Owner directories list other objects owned by an account, such as RippleState (trust line) or Offer objects.
• Offer directories list the offers available in the decentralized exchange. A single Offer directory contains all the offers that have the same exchange rate for the same token.

<https://xrpl.org/directorynode.html#directorynode>

Fields

common_fields: CommonFields<'a, NoFlags>

The base fields for all ledger object models.

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

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

(Offer Directories only) DEPRECATED. Do not use.

indexes: Vec<Cow<'a, str>>

The contents of this Directory: an array of IDs of other objects.

root_index: Cow<'a, str>

The ID of root object for this directory.

index_next: Option<u64>

If this Directory consists of multiple pages, this ID links to the next object in the chain, wrapping around at the end.

index_previous: Option<u64>

If this Directory consists of multiple pages, this ID links to the previous object in the chain, wrapping around at the beginning.

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

(Owner Directories only) The address of the account that owns the objects in this directory.

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

(Offer Directories only) The currency code of the TakerGets amount from the offers in this directory.

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

(Offer Directories only) The currency code of the TakerPays amount from the offers in this (Offer Directories only) The issuer of the TakerGets amount from the offers in this directory.

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

directory.

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

(Offer Directories only) The issuer of the TakerPays amount from the offers in this directory.

Implementations

impl<'a> DirectoryNode<'a>

pub fn new( index: Option<Cow<'a, str>>, ledger_index: Option<Cow<'a, str>>, indexes: Vec<Cow<'a, str>>, root_index: Cow<'a, str>, exchange_rate: Option<Cow<'a, str>>, index_next: Option<u64>, index_previous: Option<u64>, owner: Option<Cow<'a, str>>, taker_gets_currency: Option<Cow<'a, str>>, taker_gets_issuer: Option<Cow<'a, str>>, taker_pays_currency: Option<Cow<'a, str>>, taker_pays_issuer: Option<Cow<'a, str>>, ) -> Self

Trait Implementations

impl<'a> Clone for DirectoryNode<'a>

fn clone(&self) -> DirectoryNode<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for DirectoryNode<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for DirectoryNode<'a>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> LedgerObject<NoFlags> for DirectoryNode<'a>

fn get_ledger_entry_type(&self) -> LedgerEntryType

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

impl<'a> Model for DirectoryNode<'a>

fn get_errors(&self) -> XRPLModelResult<()>

Collects a models errors and returns the first error that occurs.

fn validate(&self) -> XRPLModelResult<()>

Simply forwards the error from get_errors if there was one.

fn is_valid(&self) -> bool

Checks if the model is valid.

impl<'a> PartialEq for DirectoryNode<'a>

fn eq(&self, other: &DirectoryNode<'a>) -> 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> Serialize for DirectoryNode<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for DirectoryNode<'a>

impl<'a> StructuralPartialEq for DirectoryNode<'a>