Struct CheckCreate

pub struct CheckCreate<'a> {
    pub common_fields: CommonFields<'a, NoFlags>,
    pub destination: Cow<'a, str>,
    pub send_max: Amount<'a>,
    pub destination_tag: Option<u32>,
    pub expiration: Option<u32>,
    pub invoice_id: Option<Cow<'a, str>>,
}

Create a Check object in the ledger, which is a deferred payment that can be cashed by its intended destination.

See CheckCreate: <https://xrpl.org/docs/references/protocol/transactions/types/checkcreate>

Fields

common_fields: CommonFields<'a, NoFlags>

The base fields for all transaction models.

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

destination: Cow<'a, str>

The unique address of the account that can cash the Check.

send_max: Amount<'a>

Maximum amount of source currency the Check is allowed to debit the sender, including transfer fees on non-XRP currencies. The Check can only credit the destination with the same currency (from the same issuer, for non-XRP currencies). For non-XRP amounts, the nested field names MUST be lower-case.

destination_tag: Option<u32>

Arbitrary tag that identifies the reason for the Check, or a hosted recipient to pay.

expiration: Option<u32>

Time after which the Check is no longer valid, in seconds since the Ripple Epoch.

invoice_id: Option<Cow<'a, str>>

Arbitrary 256-bit hash representing a specific reason or identifier for this Check.

Implementations

impl<'a> CheckCreate<'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>, destination: Cow<'a, str>, send_max: Amount<'a>, destination_tag: Option<u32>, expiration: Option<u32>, invoice_id: Option<Cow<'a, str>>, ) -> Self

pub fn with_destination_tag(self, destination_tag: u32) -> Self

pub fn with_expiration(self, expiration: u32) -> Self

pub fn with_invoice_id(self, invoice_id: Cow<'a, str>) -> Self

Trait Implementations

impl<'a> Clone for CheckCreate<'a>

fn clone(&self) -> CheckCreate<'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 CheckCreate<'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 CheckCreate<'a>

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

Formats the value using the given formatter.

impl<'a> Default for CheckCreate<'a>

fn default() -> CheckCreate<'a>

Returns the “default value” for a type.

impl<'de, 'a> Deserialize<'de> for CheckCreate<'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 CheckCreate<'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 CheckCreate<'a>

fn eq(&self, other: &CheckCreate<'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 CheckCreate<'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 CheckCreate<'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 CheckCreate<'a>

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

impl<'a> Eq for CheckCreate<'a>

impl<'a> StructuralPartialEq for CheckCreate<'a>