Skip to main content

EscrowFinish

Struct EscrowFinish 

#[repr(C)]
pub struct EscrowFinish;
Expand description

Represents an EscrowFinish transaction in the XRPL Programmability environment.

This zero-sized type serves as a marker for EscrowFinish transactions and provides access to transaction-specific fields through trait implementations. The structure implements both common transaction fields (available to all transaction types) and escrow-finish-specific fields.

§Field Access

Through the implemented traits, this structure provides access to:

§Common Transaction Fields (via TransactionCommonFields)

  • Account (transaction sender)
  • Fee (transaction cost in drops)
  • Sequence (account sequence number)
  • LastLedgerSequence (transaction expiration)
  • And other standard XRPL transaction fields

§EscrowFinish-Specific Fields (via EscrowFinishFields)

  • Owner (account that created the escrow)
  • OfferSequence (sequence number of the EscrowCreate transaction)
  • Condition (cryptographic condition, if present)
  • Fulfillment (cryptographic fulfillment, if present)

§Zero-Cost Abstraction

This structure has no runtime overhead as it contains no data fields. All field access is performed through the trait methods, which directly call the underlying host functions to retrieve data from the current transaction context.

Trait Implementations§

§

impl Clone for EscrowFinish

§

fn clone(&self) -> EscrowFinish

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Copy for EscrowFinish

§

impl Debug for EscrowFinish

§

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

Formats the value using the given formatter. Read more
§

impl Eq for EscrowFinish

§

impl EscrowFinishFields for EscrowFinish

Implementation of EscrowFinish-specific transaction fields.

This implementation provides access to fields that are specific to EscrowFinish transactions, such as Owner, OfferSequence, Condition, and Fulfillment. The methods are provided by the EscrowFinishFields trait.

§

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

Retrieves the owner account from the current EscrowFinish transaction. Read more
§

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

Retrieves the offer sequence from the current EscrowFinish transaction. Read more
§

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

Retrieves the cryptographic condition from the current EscrowFinish transaction. Read more
§

fn get_fulfillment( &self, ) -> Result<Option<Blob<xrpl_wasm_stdlib::::core::types::blob::FulfillmentBlob::{constant#0}>>>

Retrieves the cryptographic fulfillment from the current EscrowFinish transaction. Read more
§

impl PartialEq for EscrowFinish

§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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 StructuralPartialEq for EscrowFinish

§

impl TransactionCommonFields for EscrowFinish

Implementation of common transaction fields for EscrowFinish transactions.

This implementation provides access to standard XRPL transaction fields that are present in all transaction types, such as Account, Fee, Sequence, and others. The methods are provided by the TransactionCommonFields trait.

§

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

Retrieves the account field from the current transaction. Read more
§

fn get_transaction_type(&self) -> Result<TransactionType>

Retrieves the transaction type from the current transaction. Read more
§

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

Retrieves the computation allowance from the current transaction. Read more
§

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

Retrieves the fee amount from the current transaction. Read more
§

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

Retrieves the sequence number from the current transaction. Read more
§

fn get_account_txn_id( &self, ) -> Result<Option<UInt<xrpl_wasm_stdlib::::core::types::uint::UInt256::{constant#0}>>>

Retrieves the account transaction ID from the current transaction. Read more
§

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

Retrieves the flags field from the current transaction. Read more
§

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

Retrieves the last ledger sequence from the current transaction. Read more
§

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

Retrieves the network ID from the current transaction. Read more
§

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

Retrieves the source tag from the current transaction. Read more
§

fn get_signing_pub_key(&self) -> Result<Option<PublicKey>>

Retrieves the signing public key from the current transaction. Read more
§

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

Retrieves the ticket sequence from the current transaction. Read more
§

fn get_txn_signature( &self, ) -> Result<Blob<xrpl_wasm_stdlib::::core::types::blob::SignatureBlob::{constant#0}>>

Retrieves the transaction signature from the current transaction. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.