Struct lightning::routing::router::Route

pub struct Route {
    pub paths: Vec<Vec<RouteHop>>,
    pub payment_params: Option<PaymentParameters>,
}

A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP, it can take multiple paths. Each path is composed of one or more hops through the network.

Fields

paths: Vec<Vec<RouteHop>>

The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the last RouteHop in each path must be the same. Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the destination. Thus, this must always be at least length one. While the maximum length of any given path is variable, keeping the length of any path less or equal to 19 should currently ensure it is viable.

payment_params: Option<PaymentParameters>

The payment_params parameter passed to find_route. This is used by ChannelManager to track information which may be required for retries, provided back to you via Event::PaymentPathFailed.

Implementations

impl Route

pub fn get_total_fees(&self) -> u64

Returns the total amount of fees paid on this Route.

This doesn’t include any extra payment made to the recipient, which can happen in excess of the amount passed to find_route’s params.final_value_msat.

pub fn get_total_amount(&self) -> u64

Returns the total amount paid on this Route, excluding the fees.

Trait Implementations

impl Clone for Route

fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for Route

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<Route> for Route

fn eq(&self, other: &Route) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Route) -> bool

This method tests for !=.

impl Readable for Route

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

Reads a Self in from the given Read

impl Writeable for Route

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

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 Route

impl StructuralEq for Route

impl StructuralPartialEq for Route