Struct RouteHintHop

pub struct RouteHintHop {
    pub src_node_id: Vec<u8>,
    pub short_channel_id: u64,
    pub base_msat: u32,
    pub proportional_millionths: u32,
    pub cltv_expiry_delta: u32,
    pub htlc_minimum_msat: Option<u64>,
    pub htlc_maximum_msat: Option<u64>,
}

Fields

src_node_id: Vec<u8>

The node_id of the non-target end of the route.

short_channel_id: u64

The short_channel_id of this channel.

base_msat: u32

Flat routing fee in millisatoshis.

proportional_millionths: u32

Liquidity-based routing fee in millionths of a routed amount. In other words, 10000 is 1%.

cltv_expiry_delta: u32

The difference in CLTV values between this node and the next node.

htlc_minimum_msat: Option<u64>

The minimum value, in msat, which must be relayed to the next hop.

htlc_maximum_msat: Option<u64>

The maximum value in msat available for routing with a single HTLC.

Implementations

impl RouteHintHop

pub fn htlc_minimum_msat(&self) -> u64

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

pub fn htlc_maximum_msat(&self) -> u64

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

Trait Implementations

impl Clone for RouteHintHop

fn clone(&self) -> RouteHintHop

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RouteHintHop

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

Formats the value using the given formatter.

impl Default for RouteHintHop

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RouteHintHop

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for RouteHintHop

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 RouteHintHop

fn eq(&self, other: &RouteHintHop) -> 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 Serialize for RouteHintHop

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<RouteHintHop> for RouteHintHop

type Error = Error

The type returned in the event of a conversion error.

fn try_from(hop: RouteHintHop) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for RouteHintHop