Enum PathFailure

pub enum PathFailure {
    InitialSend {
        err: APIError,
    },
    OnPath {
        network_update: Option<NetworkUpdate>,
    },
}

When the payment path failure took place and extra details about it. PathFailure::OnPath may contain a NetworkUpdate that needs to be applied to the NetworkGraph.

Variants

InitialSend

We failed to initially send the payment and no HTLC was committed to. Contains the relevant error.

Fields

err: APIError

The error surfaced from initial send.

OnPath

A hop on the path failed to forward our payment.

Fields

network_update: Option<NetworkUpdate>

If present, this NetworkUpdate should be applied to the NetworkGraph so that routing decisions can take into account the update.

Trait Implementations

impl Clone for PathFailure

fn clone(&self) -> PathFailure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathFailure

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

Formats the value using the given formatter.

impl MaybeReadable for PathFailure

fn read<R: Read>(reader: &mut R) -> Result<Option<Self>, DecodeError>

Reads a Self in from the given Read.

impl PartialEq for PathFailure

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

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Eq for PathFailure

impl StructuralPartialEq for PathFailure