Struct CheckCash

pub struct CheckCash<'a> {
    pub common_fields: CommonFields<'a, NoFlags>,
    pub check_id: Cow<'a, str>,
    pub amount: Option<Amount<'a>>,
    pub deliver_min: Option<Amount<'a>>,
}

Attempt to redeem a Check object in the ledger to receive up to the amount authorized by a corresponding CheckCreate transaction.

See CheckCash: <https://xrpl.org/docs/references/protocol/transactions/types/checkcash>

Fields

common_fields: CommonFields<'a, NoFlags>

The base fields for all transaction models.

See Transaction Common Fields: <https://xrpl.org/transaction-common-fields.html>

check_id: Cow<'a, str>

The ID of the Check ledger object to cash, as a 64-character hexadecimal string.

amount: Option<Amount<'a>>

Redeem the Check for exactly this amount, if possible. The currency must match that of the SendMax of the corresponding CheckCreate transaction. You must provide either this field or DeliverMin.

deliver_min: Option<Amount<'a>>

Redeem the Check for at least this amount and for as much as possible. The currency must match that of the SendMax of the corresponding CheckCreate transaction. You must provide either this field or Amount.

Implementations

impl<'a> CheckCash<'a>

pub fn new( account: Cow<'a, str>, account_txn_id: Option<Cow<'a, str>>, fee: Option<XRPAmount<'a>>, last_ledger_sequence: Option<u32>, memos: Option<Vec<Memo>>, sequence: Option<u32>, signers: Option<Vec<Signer>>, source_tag: Option<u32>, ticket_sequence: Option<u32>, check_id: Cow<'a, str>, amount: Option<Amount<'a>>, deliver_min: Option<Amount<'a>>, ) -> Self

pub fn with_amount(self, amount: Amount<'a>) -> Self

pub fn with_deliver_min(self, deliver_min: Amount<'a>) -> Self

Trait Implementations

impl<'a> CheckCashError for CheckCash<'a>

fn _get_amount_and_deliver_min_error(&self) -> XRPLModelResult<()>

impl<'a> Clone for CheckCash<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> CommonTransactionBuilder<'a, NoFlags> for CheckCash<'a>

fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags>

Get mutable reference to common fields

fn into_self(self) -> Self

Return self after modification (for method chaining)

fn with_fee(self, fee: XRPAmount<'a>) -> Self

where Self: Sized,

Set fee

fn with_sequence(self, sequence: u32) -> Self

where Self: Sized,

Set sequence

fn with_last_ledger_sequence(self, last_ledger_sequence: u32) -> Self

where Self: Sized,

Set last ledger sequence

fn with_memo(self, memo: Memo) -> Self

where Self: Sized,

Add memo

fn with_source_tag(self, source_tag: u32) -> Self

where Self: Sized,

Set source tag

fn with_ticket_sequence(self, ticket_sequence: u32) -> Self

where Self: Sized,

Set ticket sequence

fn with_account_txn_id(self, account_txn_id: Cow<'a, str>) -> Self

where Self: Sized,

Set account transaction ID

impl<'a> Debug for CheckCash<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CheckCash<'a>

fn default() -> CheckCash<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for CheckCash<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn eq(&self, other: &CheckCash<'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 CheckCash<'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> Transaction<'a, NoFlags> for CheckCash<'a>

fn get_transaction_type(&self) -> &TransactionType

fn get_common_fields(&self) -> &CommonFields<'_, NoFlags>

fn get_mut_common_fields(&mut self) -> &mut CommonFields<'a, NoFlags>

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

fn get_field_value(&self, field: &str) -> XRPLModelResult<Option<String>>

fn is_signed(&self) -> bool

fn get_hash(&self) -> XRPLModelResult<Cow<'_, str>>

where Self: Serialize + DeserializeOwned + Debug + Clone,

Hashes the Transaction object as the ledger does. Only valid for signed Transaction objects.

impl<'a> ValidateCurrencies for CheckCash<'a>

fn validate_currencies(&self) -> XRPLModelResult<()>

impl<'a> Eq for CheckCash<'a>

impl<'a> StructuralPartialEq for CheckCash<'a>