Struct Escrow 

pub struct Escrow { /* private fields */ }

Implementations

impl Escrow

pub fn new(slot_num: i32) -> Escrow

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

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 Copy for Escrow

impl Debug for Escrow

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

Formats the value using the given formatter.

impl Eq for Escrow

impl EscrowFields for Escrow

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

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

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

The Sequence field (Optional).

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

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

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

The amount to be delivered by the payment in escrow. The amount can be XRP, or with the TokenEscrow amendment, a fungible token.

fn condition( &self, ) -> Result<Option<Blob<xrpl_common_stdlib::::types::blob::ConditionBlob::{constant#0}>>>

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

fn cancel_after(&self) -> 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 finish_after(&self) -> 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 bytecode( &self, ) -> Result<Option<Blob<xrpl_common_stdlib::::types::blob::WasmBlob::{constant#0}>>>

The Bytecode field (Optional).

fn data( &self, ) -> Result<Option<Blob<xrpl_common_stdlib::::types::blob::StandardBlob::{constant#0}>>>

The Data field (Optional).

fn source_tag(&self) -> 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 destination_tag(&self) -> Result<Option<u32>>

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

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

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

fn previous_txn_id( &self, ) -> Result<UInt<xrpl_common_stdlib::::types::uint::UInt256::{constant#0}>>

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

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

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

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

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 transfer_rate(&self) -> Result<Option<u32>>

The transfer rate or fee to charge when users finish an escrow, locked at the creation of an escrow contract and used during settlement. Applicable to Trust Line Tokens and MPTs only.

fn issuer_node(&self) -> Result<Option<u64>>

The ledger index of the issuer’s directory node associated with the Escrow. Used when the issuer is neither the source nor destination account.

impl LedgerObjectCommonFields for Escrow

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 Escrow

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Escrow