Struct BlindedPathConfig 

pub struct BlindedPathConfig {
    pub min_num_real_hops: Option<u32>,
    pub num_hops: Option<u32>,
    pub max_num_paths: Option<u32>,
    pub node_omission_list: Vec<Vec<u8>>,
    pub incoming_channel_list: Vec<u64>,
}

Fields

min_num_real_hops: Option<u32>

The minimum number of real hops to include in a blinded path. This doesn’t include our node, so if the minimum is 1, then the path will contain at minimum our node along with an introduction node hop. If it is zero then the shortest path will use our node as an introduction node.

num_hops: Option<u32>

The number of hops to include in a blinded path. This doesn’t include our node, so if it is 1, then the path will contain our node along with an introduction node or dummy node hop. If paths shorter than NumHops is found, then they will be padded using dummy hops.

max_num_paths: Option<u32>

The maximum number of blinded paths to select and add to an invoice.

node_omission_list: Vec<Vec<u8>>

A list of node IDs of nodes that should not be used in any of our generated blinded paths.

incoming_channel_list: Vec<u64>

The chained channels list specified via channel id (separated by commas), starting from a channel owned by the receiver node.

Implementations

impl BlindedPathConfig

pub fn min_num_real_hops(&self) -> u32

Returns the value of min_num_real_hops, or the default value if min_num_real_hops is unset.

pub fn num_hops(&self) -> u32

Returns the value of num_hops, or the default value if num_hops is unset.

pub fn max_num_paths(&self) -> u32

Returns the value of max_num_paths, or the default value if max_num_paths is unset.

Trait Implementations

impl Clone for BlindedPathConfig

fn clone(&self) -> BlindedPathConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlindedPathConfig

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

Formats the value using the given formatter.

impl Default for BlindedPathConfig

fn default() -> Self

Returns the “default value” for a type.

impl Hash for BlindedPathConfig

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 Message for BlindedPathConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for BlindedPathConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for BlindedPathConfig

impl StructuralPartialEq for BlindedPathConfig