Struct Payment 

pub struct Payment { /* private fields */ }

A parsed payment category from a payment instruction string.

This can be a Bitcoin address, Liquid address, Lightning invoice, Lightning offer, LNURL, BIP353, BIP21 URI, or Liquid BIP21 URI.

Implementations

impl Payment

pub fn new(s: &str) -> Result<Arc<Self>, LwkError>

Parse a payment instruction string into a PaymentCategory

pub fn kind(&self) -> PaymentKind

Returns the kind of payment category

pub fn bitcoin_address(&self) -> Option<Arc<BitcoinAddress>>

Returns the Bitcoin address if this is a BitcoinAddress category, None otherwise

Returns the address portion of the original input string

pub fn liquid_address(&self) -> Option<Arc<Address>>

Returns the Liquid address if this is a LiquidAddress category, None otherwise

pub fn lightning_invoice(&self) -> Option<Arc<Bolt11Invoice>>

Available on crate feature lightning only.

Returns the Lightning invoice if this is a LightningInvoice category, None otherwise

pub fn lightning_offer(&self) -> Option<String>

Returns the Lightning offer as a string if this is a LightningOffer category, None otherwise

pub fn lnurl(&self) -> Option<String>

Returns the LNURL as a string if this is an LnUrl category, None otherwise

pub fn bip353(&self) -> Option<String>

Returns the BIP353 address (without the ₿ prefix) if this is a Bip353 category, None otherwise

pub fn bip21(&self) -> Option<Arc<Bip21>>

Returns the BIP21 URI if this is a Bip21 category, None otherwise

pub fn bip321(&self) -> Option<Arc<Bip321>>

Returns the BIP321 URI if this is a Bip321 category, None otherwise

pub fn liquid_bip21(&self) -> Option<LiquidBip21>

Returns the Liquid BIP21 details if this is a LiquidBip21 category, None otherwise

pub fn lightning_payment(&self) -> Option<Arc<LightningPayment>>

Available on crate feature lightning only.

Returns a `LightningPayment`` if this category is payable via Lightning

Returns Some for LightningInvoice, LightningOffer, and LnUrl categories. The returned LightningPayment can be used with BoltzSession::prepare_pay().

Trait Implementations

impl Display for Payment

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for Payment

type LiftType = Arc<Payment>

impl<UT> LowerError<UT> for Payment

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for Payment

type ReturnType = <Arc<Payment> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for Payment

const TYPE_ID_META: MetadataBuffer