Struct lightning::ln::router::Route

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

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 to less than 20 should currently ensure it is viable.

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 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 StructuralPartialEq for Route

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 encode_with_len(&self) -> Vec<u8>

Writes self out to a Vec