Enum PaymentSendFailure

pub enum PaymentSendFailure {
    ParameterError(APIError),
    PathParameterError(Vec<Result<(), APIError>>),
    AllFailedResendSafe(Vec<APIError>),
    DuplicatePayment,
    PartialFailure {
        results: Vec<Result<(), APIError>>,
        failed_paths_retry: Option<RouteParameters>,
        payment_id: PaymentId,
    },
}

If a payment fails to send with ChannelManager::send_payment_with_route, it can be in one of several states. This enum is returned as the Err() type describing which state the payment is in, see the description of individual enum states for more.

Variants

ParameterError(APIError)

A parameter which was passed to send_payment was invalid, preventing us from attempting to send the payment at all.

You can freely resend the payment in full (with the parameter error fixed).

Because the payment failed outright, no payment tracking is done and no Event::PaymentPathFailed or Event::PaymentFailed events will be generated.

PathParameterError(Vec<Result<(), APIError>>)

A parameter in a single path which was passed to send_payment was invalid, preventing us from attempting to send the payment at all.

You can freely resend the payment in full (with the parameter error fixed).

Because the payment failed outright, no payment tracking is done and no Event::PaymentPathFailed or Event::PaymentFailed events will be generated.

The results here are ordered the same as the paths in the route object which was passed to send_payment.

AllFailedResendSafe(Vec<APIError>)

All paths which were attempted failed to send, with no channel state change taking place. You can freely resend the payment in full (though you probably want to do so over different paths than the ones selected).

Because the payment failed outright, no payment tracking is done and no Event::PaymentPathFailed or Event::PaymentFailed events will be generated.

DuplicatePayment

Indicates that a payment for the provided PaymentId is already in-flight and has not yet completed (i.e. generated an Event::PaymentSent or Event::PaymentFailed).

PartialFailure

Some paths that were attempted failed to send, though some paths may have succeeded. At least some paths have irrevocably committed to the HTLC.

The results here are ordered the same as the paths in the route object that was passed to send_payment.

Any entries that contain Err(APIError::MonitorUpdateInprogress) will send once a MonitorEvent::Completed is provided for the next-hop channel with the latest update_id.

Fields

results: Vec<Result<(), APIError>>

The errors themselves, in the same order as the paths from the route.

failed_paths_retry: Option<RouteParameters>

If some paths failed without irrevocably committing to the new HTLC(s), this will contain a RouteParameters object for the failing paths.

payment_id: PaymentId

The payment id for the payment, which is now at least partially pending.

Trait Implementations

impl Clone for PaymentSendFailure

fn clone(&self) -> PaymentSendFailure

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PaymentSendFailure

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

Formats the value using the given formatter.

impl PartialEq for PaymentSendFailure

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

impl StructuralPartialEq for PaymentSendFailure