Struct Escrow

#[repr(C)]
pub struct Escrow;

Trait Implementations

impl Clone for Escrow

fn clone(&self) -> Escrow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Escrow

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

Formats the value using the given formatter.

impl EscrowFields for Escrow

fn get_account(&self, register_num: i32) -> Result<AccountID>

The address of the owner (sender) of this escrow. This is the account that provided the XRP and gets it back if the escrow is canceled.

fn get_amount(&self, register_num: i32) -> Result<TokenAmount>

The amount of XRP, in drops, currently held in the escrow.

fn get_cancel_after(&self, register_num: i32) -> Result<Option<u32>>

The escrow can be canceled if and only if this field is present and the time it specifies has passed. Specifically, this is specified as seconds since the Ripple Epoch and it “has passed” if it’s earlier than the close time of the previous validated ledger.

fn get_condition(&self, register_num: i32) -> Result<Option<Condition>>

A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the EscrowFinish transaction must contain a fulfillment that satisfies this condition.

fn get_destination(&self, register_num: i32) -> Result<AccountID>

The destination address where the XRP is paid if the escrow is successful.

fn get_destination_node(&self, register_num: i32) -> Result<Option<Hash256>>

A hint indicating which page of the destination’s owner directory links to this object, in case the directory consists of multiple pages. Omitted on escrows created before enabling the fix1523 amendment.

fn get_destination_tag(&self, register_num: i32) -> Result<Option<u32>>

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

fn get_finish_after(&self, register_num: i32) -> Result<Option<u32>>

The time, in seconds since the Ripple Epoch, after which this escrow can be finished. Any EscrowFinish transaction before this time fails. (Specifically, this is compared with the close time of the previous validated ledger.)

fn get_owner_node(&self, register_num: i32) -> Result<Hash256>

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

fn get_previous_txn_id(&self, register_num: i32) -> Result<Hash256>

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

fn get_previous_txn_lgr_seq(&self, register_num: i32) -> Result<u32>

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

fn get_source_tag(&self, register_num: i32) -> Result<Option<u32>>

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

fn get_finish_function(&self, register_num: i32) -> Result<Option<Blob>>

The WASM code that is executing.

fn get_data(&self, register_num: i32) -> Result<ContractData>

Retrieves the contract data from the specified ledger object.

impl LedgerObjectCommonFields for Escrow

fn get_ledger_index(&self, register_num: i32) -> Result<Hash256>

Retrieves the ledger index (unique identifier) of the ledger object.

fn get_flags(&self, register_num: i32) -> 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 Escrow

fn eq(&self, other: &Escrow) -> 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 Copy for Escrow

impl Eq for Escrow

impl StructuralPartialEq for Escrow