Struct lightning_invoice::PrivateRoute

pub struct PrivateRoute(_);

Private routing information

Invariants

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

Implementations

impl PrivateRoute

pub fn new(hops: RouteHint) -> Result<PrivateRoute, CreationError>

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

pub fn into_inner(self) -> RouteHint

Returns the underlying list of hops

Trait Implementations

impl Base32Len for PrivateRoute

fn base32_len(&self) -> usize

Calculate the base32 serialized length

impl Clone for PrivateRoute

fn clone(&self) -> PrivateRoute

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrivateRoute

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

Formats the value using the given formatter.

impl Deref for PrivateRoute

type Target = RouteHint

The resulting type after dereferencing.

fn deref(&self) -> &RouteHint

Dereferences the value.

impl FromBase32 for PrivateRoute

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<PrivateRoute, ParseError>

Convert a base32 slice to Self.

impl Hash for PrivateRoute

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Into<RouteHint> for PrivateRoute

fn into(self) -> RouteHint

Converts this type into the (usually inferred) input type.

impl PartialEq<PrivateRoute> for PrivateRoute

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToBase32 for PrivateRoute

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

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

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

Convert Self to base32 vector

impl Eq for PrivateRoute

impl StructuralEq for PrivateRoute

impl StructuralPartialEq for PrivateRoute