Struct lightning_invoice::Route

pub struct Route(_);

Private routing information

Invariants

The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)

Methods

impl Route

pub fn new(hops: Vec<RouteHop>) -> Result<Route, CreationError>

Create a new (partial) route from a list of hops

pub fn into_inner(self) -> Vec<RouteHop>

Returrn the underlying vector of hops

Methods from Deref<Target = Vec<RouteHop>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

pub fn as_slice(&self) -> &[T]

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

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

impl Into<Vec<RouteHop>> for Route

fn into(self) -> Vec<RouteHop>

Performs the conversion.

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

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

Formats the value using the given formatter.

impl Deref for Route

type Target = Vec<RouteHop>

The resulting type after dereferencing.

fn deref(&self) -> &Vec<RouteHop>

Dereferences the value.

impl FromBase32 for Route

type Err = ParseError

The associated error which can be returned from parsing (e.g. because of bad padding).

fn from_base32(field_data: &[u5]) -> Result<Route, ParseError>

Convert a base32 slice to Self.

impl ToBase32<Vec<u5>> for Route

fn to_base32(&self) -> Vec<u5>

Convert Self to base32 slice