Struct Check

pub struct Check<'a> {

    pub common_fields: CommonFields<'a, NoFlags>,
    pub account: Cow<'a, str>,
    pub destination: Cow<'a, str>,
    pub owner_node: Cow<'a, str>,
    pub previous_txn_id: Cow<'a, str>,
    pub previous_txn_lgr_seq: u32,
    pub send_max: Amount<'a>,
    pub sequence: u32,
    pub destination_node: Option<Cow<'a, str>>,
    pub destination_tag: Option<u32>,
    pub expiration: Option<u32>,
    pub invoice_id: Option<Cow<'a, str>>,
    pub source_tag: Option<u32>,
}

A Check object describes a check, similar to a paper personal check, which can be cashed by its destination to get money from its sender.

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

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>

account: Cow<'a, str>

The sender of the Check. Cashing the Check debits this address’s balance.

destination: Cow<'a, str>

The intended recipient of the Check. Only this address can cash the Check, using a CheckCash transaction.

owner_node: Cow<'a, str>

A hint indicating which page of the sender’s owner directory links to this object, in case the directory consists of multiple pages.

previous_txn_id: Cow<'a, str>

The identifying hash of the transaction that most recently modified this object.

previous_txn_lgr_seq: u32

The index of the ledger that contains the transaction that most recently modified this object.

send_max: Amount<'a>

The maximum amount of currency this Check can debit the sender. If the Check is successfully cashed, the destination is credited in the same currency for up to this amount.

sequence: u32

The sequence number of the CheckCreate transaction that created this check.

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

A hint indicating which page of the destination’s owner directory links to this object, in case the directory consists of multiple pages.

destination_tag: Option<u32>

An arbitrary tag to further specify the destination for this Check, such as a hosted recipient at the destination address.

expiration: Option<u32>

Indicates the time after which this Check is considered expired.

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

Arbitrary 256-bit hash provided by the sender as a specific reason or identifier for this Check.

source_tag: Option<u32>

An arbitrary tag to further specify the source for this Check, such as a hosted recipient at the sender’s address.

Implementations

impl<'a> Check<'a>

pub fn new( index: Option<Cow<'a, str>>, ledger_index: Option<Cow<'a, str>>, account: Cow<'a, str>, destination: Cow<'a, str>, owner_node: Cow<'a, str>, previous_txn_id: Cow<'a, str>, previous_txn_lgr_seq: u32, send_max: Amount<'a>, sequence: u32, destination_node: Option<Cow<'a, str>>, destination_tag: Option<u32>, expiration: Option<u32>, invoice_id: Option<Cow<'a, str>>, source_tag: Option<u32>, ) -> Self

Trait Implementations

impl<'a> Clone for Check<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Check<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Check<'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 Check<'a>

fn get_ledger_entry_type(&self) -> LedgerEntryType

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

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

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

impl<'a> StructuralPartialEq for Check<'a>