Struct Check 

pub struct Check { /* private fields */ }

Implementations

impl Check

pub fn new(slot_num: i32) -> Self

Binds this handle to a host-managed slot holding a Check ledger object.

Trait Implementations

impl CheckFields for Check

fn account(&self) -> Result<AccountID>

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

fn destination(&self) -> Result<AccountID>

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

fn send_max(&self) -> Result<Amount>

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.

fn sequence(&self) -> Result<u32>

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

fn owner_node(&self) -> Result<u64>

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

fn destination_node(&self) -> Result<u64>

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

fn expiration(&self) -> Result<Option<u32>>

Indicates the time after which this Check is considered expired. See Specifying Time for details.

fn invoice_id(&self) -> Result<Option<Hash256>>

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

fn source_tag(&self) -> Result<Option<u32>>

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

fn destination_tag(&self) -> Result<Option<u32>>

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

fn previous_txn_id(&self) -> Result<Hash256>

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

fn previous_txn_lgr_seq(&self) -> Result<u32>

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

impl Clone for Check

fn clone(&self) -> Check

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Check

impl Debug for Check

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

Formats the value using the given formatter.

impl Eq for Check

impl LedgerObjectCommonFields for Check

fn get_slot_num(&self) -> i32

Returns the slot number (register number) where the ledger object is stored.

fn path(&self) -> LedgerPathBuilder

Starts a nested-field path rooted at this ledger object, read through its slot.

fn get_flags(&self) -> Result<u32>

Retrieves the flags field of the ledger object.

fn get_ledger_entry_type(&self) -> Result<u16>

Retrieves the ledger entry type of the object.

impl PartialEq for Check

fn eq(&self, other: &Check) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Check