Enum PaymentId

pub enum PaymentId {
    OfferRecvReusable(LnClaimId),
    OfferSend(ClientPaymentId),
    Lightning(PaymentHash),
    OnchainRecv(Txid),
    OnchainSend(ClientPaymentId),
}

A globally unique identifier for any payment (Lightning or on-chain). Serialized as "<prefix>_<hex>", e.g. "ln_3ddc..." or "os_0a19...".

Prefixes: ln (Lightning), or (on-chain receive), os (on-chain send), fr (offer receive), fs (offer send).

Variants

OfferRecvReusable(LnClaimId)

OfferSend(ClientPaymentId)

Lightning(PaymentHash)

OnchainRecv(Txid)

OnchainSend(ClientPaymentId)

Implementations

impl PaymentId

pub const MIN: PaymentId

The PaymentId that is lexicographically <= all other ids.

pub const MAX: PaymentId

The PaymentId that is lexicographically >= all other ids.

pub fn prefix(&self) -> &'static str

Returns the prefix to use when serializing this payment id to a string.

pub fn from_ldk_event( ldk_payment_id: Option<PaymentId>, payment_hash: PaymentHash, ) -> PaymentId

Construct an PaymentId from LDK event fields.

pub fn from_payment_failed( ldk_payment_id: PaymentId, payment_hash: Option<PaymentHash>, ) -> PaymentId

From the data we get in a PaymentFailed event, determine the payment id for this outbound lightning payment.

Trait Implementations

impl Clone for PaymentId

fn clone(&self) -> PaymentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentId

where PaymentId: FromStr, <PaymentId as FromStr>::Err: Display,

fn deserialize<__D>( deserializer: __D, ) -> Result<PaymentId, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PaymentId

<kind>_<id>

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

Formats the value using the given formatter.

impl FromStr for PaymentId

<kind>_<id>

type Err = Error

The associated error which can be returned from parsing.

fn from_str(kind_id: &str) -> Result<PaymentId, Error>

Parses a string s to return a value of this type.

impl Hash for PaymentId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PaymentId

fn cmp(&self, other: &PaymentId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PaymentId

fn eq(&self, other: &PaymentId) -> 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 PartialOrd for PaymentId

fn partial_cmp(&self, other: &PaymentId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PaymentId

where PaymentId: Display,

fn serialize<__S>( &self, serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PaymentId> for ClientPaymentId

type Error = Error

The type returned in the event of a conversion error.

fn try_from(id: PaymentId) -> Result<ClientPaymentId, Error>

Performs the conversion.

impl TryFrom<PaymentId> for PaymentHash

type Error = Error

The type returned in the event of a conversion error.

fn try_from(id: PaymentId) -> Result<PaymentHash, Error>

Performs the conversion.

impl Copy for PaymentId

impl Eq for PaymentId

impl StructuralPartialEq for PaymentId