Enum PaymentStatus 

pub enum PaymentStatus {
    Created,
    Inflight,
    Success,
    Failed,
}

The status of a payment, will update as the payment progresses. The transfer path for payment status is Created -> Inflight -> Success | Failed.

MPP Behavior: A single session may involve multiple attempts (HTLCs) to fulfill the total amount.

Variants

Created

Initial status. A payment session is created, but no HTLC has been dispatched.

Inflight

The first hop AddTlc is sent successfully and waiting for the response.

MPP Logic: Status Inflight means at least one attempt is still not in Success, payment needs more retrying or waiting for HTLC settlement.

Success

The payment is finished. All related HTLCs are successfully settled, and the aggregate amount equals the total requested amount.

Failed

The payment session has terminated. HTLCs have failed and the target amount cannot be fulfilled after exhausting all retries.

Implementations

impl PaymentStatus

pub fn is_final(&self) -> bool

Trait Implementations

impl Clone for PaymentStatus

fn clone(&self) -> PaymentStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PaymentStatus

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PaymentStatus

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PaymentStatus

impl Eq for PaymentStatus

impl StructuralPartialEq for PaymentStatus