Enum PaymentOption

#[non_exhaustive]
pub enum PaymentOption {
    AttachedCycles {
        fee: Option<TokenAmount>,
    },
    CallerPaysIcrc2Cycles {
        fee: Option<TokenAmount>,
    },
    PatronPaysIcrc2Cycles {
        fee: Option<TokenAmount>,
    },
}

Billing options that may be offered to a customer.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AttachedCycles

The caller is paying with cycles attached to the call.

Note: This is available to inter-canister aclls only; not to ingress messages.

Note: The API does not require additional arguments to support this payment type.

Fields

fee: Option<TokenAmount>

CallerPaysIcrc2Cycles

The caller is paying with cycles from their main account on the cycles ledger.

Fields

fee: Option<TokenAmount>

PatronPaysIcrc2Cycles

A patron is paying, on behalf of the caller, from their main account on the cycles ledger.

Fields

fee: Option<TokenAmount>

Trait Implementations

impl CandidType for PaymentOption

fn _ty() -> Type

fn id() -> TypeId

fn idl_serialize<__S>(&self, __serializer: __S) -> Result<(), __S::Error>

where __S: Serializer,

fn ty() -> Type

impl Clone for PaymentOption

fn clone(&self) -> PaymentOption

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentOption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentOption

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PaymentOption

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

Tests for self and other values to be equal, and is used by ==.

const 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 PaymentOption

impl Eq for PaymentOption

impl StructuralPartialEq for PaymentOption