Struct Ledger

pub struct Ledger<'a> {
    pub common_fields: CommonFields<'a>,
    pub accounts: Option<bool>,
    pub binary: Option<bool>,
    pub expand: Option<bool>,
    pub full: Option<bool>,
    pub ledger_hash: Option<Cow<'a, str>>,
    pub ledger_index: Option<Cow<'a, str>>,
    pub owner_funds: Option<bool>,
    pub queue: Option<bool>,
    pub transactions: Option<bool>,
}

Retrieve information about the public ledger.

See Ledger Data: <https://xrpl.org/ledger.html>

Fields

common_fields: CommonFields<'a>

The common fields shared by all requests.

accounts: Option<bool>

Admin required. If true, return information on accounts in the ledger. Ignored if you did not specify a ledger version. Defaults to false. Caution: This returns a very large amount of data!

binary: Option<bool>

If true, and transactions and expand are both also true, return transaction information in binary format (hexadecimal string) instead of JSON format.

expand: Option<bool>

Provide full JSON-formatted information for transaction/account information instead of only hashes. Defaults to false. Ignored unless you request transactions, accounts, or both.

full: Option<bool>

Admin required. If true, return full information on the entire ledger. Ignored if you did not specify a ledger version. Defaults to false. (Equivalent to enabling transactions, accounts, and expand.) Caution: This is a very large amount of data – on the order of several hundred megabytes!

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

A 20-byte hex string for the ledger version to use.

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

The ledger index of the ledger to use, or a shortcut string to choose a ledger automatically.

owner_funds: Option<bool>

If true, include owner_funds field in the metadata of OfferCreate transactions in the response. Defaults to false. Ignored unless transactions are included and expand is true.

queue: Option<bool>

If true, and the command is requesting the current ledger, includes an array of queued transactions in the results.

transactions: Option<bool>

If true, return information on transactions in the specified ledger version. Defaults to false. Ignored if you did not specify a ledger version.

Implementations

impl<'a> Ledger<'a>

pub fn new( id: Option<Cow<'a, str>>, accounts: Option<bool>, binary: Option<bool>, expand: Option<bool>, full: Option<bool>, ledger_hash: Option<Cow<'a, str>>, ledger_index: Option<Cow<'a, str>>, owner_funds: Option<bool>, queue: Option<bool>, transactions: Option<bool>, ) -> Self

Trait Implementations

impl<'a> Clone for Ledger<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Ledger<'a>

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<Ledger<'a>> for XRPLRequest<'a>

fn from(request: Ledger<'a>) -> Self

Converts to this type from the input type.

impl<'a> Model for Ledger<'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 Ledger<'a>

fn eq(&self, other: &Ledger<'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> Request<'a> for Ledger<'a>

fn get_common_fields(&self) -> &CommonFields<'a>

fn get_common_fields_mut(&mut self) -> &mut CommonFields<'a>

impl<'a> Serialize for Ledger<'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 Ledger<'a>

impl<'a> StructuralPartialEq for Ledger<'a>