Struct lnpbp::lnp::application::payment::invoice::Route

pub struct Route(_);

Private routing information

Invariants

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

Implementations

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 as_ptr(&self) -> *const T

Returns a raw pointer to the vector's buffer.

The caller must ensure that the vector outlives the pointer this function returns, or else it will end up pointing to garbage. Modifying the vector may cause its buffer to be reallocated, which would also make any pointers to it invalid.

The caller must also ensure that the memory the pointer (non-transitively) points to is never written to (except inside an UnsafeCell) using this pointer or any pointer derived from it. If you need to mutate the contents of the slice, use as_mut_ptr.

Examples

let x = vec![1, 2, 4];
let x_ptr = x.as_ptr();

unsafe {
    for i in 0..x.len() {
        assert_eq!(*x_ptr.add(i), 1 << i);
    }
}

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

pub fn base32_len(&self) -> usize

Calculate the base32 serialized length

impl Clone for Route

pub fn clone(&self) -> Route

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Route

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

Formats the value using the given formatter.

impl Deref for Route

type Target = Vec<RouteHop>

The resulting type after dereferencing.

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

Dereferences the value.

impl Eq for Route

impl FromBase32 for Route

type Err = ParseError

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

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

Convert a base32 slice to Self.

impl Into<Vec<RouteHop>> for Route

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

Performs the conversion.

impl PartialEq<Route> for Route

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

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

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

This method tests for !=.

impl StructuralEq for Route

impl StructuralPartialEq for Route

impl ToBase32 for Route

pub fn write_base32<W>(
    &self,
    writer: &mut W
) -> Result<(), <W as WriteBase32>::Err> where
    W: WriteBase32, 

Encode as base32 and write it to the supplied writer Implementations shouldn't allocate.

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

Convert Self to base32 vector