Struct lightning::routing::router::Payee

pub struct Payee {
    pub pubkey: PublicKey,
    pub features: Option<InvoiceFeatures>,
    pub route_hints: Vec<RouteHint>,
    pub expiry_time: Option<u64>,
}

The recipient of a payment.

Fields

pubkey: PublicKey

The node id of the payee.

features: Option<InvoiceFeatures>

Features supported by the payee.

May be set from the payee’s invoice or via for_keysend. May be None if the invoice does not contain any features.

route_hints: Vec<RouteHint>

Hints for routing to the payee, containing channels connecting the payee to public nodes.

expiry_time: Option<u64>

Expiration of a payment to the payee, in seconds relative to the UNIX epoch.

Implementations

impl Payee

pub fn from_node_id(pubkey: PublicKey) -> Self

Creates a payee with the node id of the given pubkey.

pub fn for_keysend(pubkey: PublicKey) -> Self

Creates a payee with the node id of the given pubkey to use for keysend payments.

pub fn with_features(self, features: InvoiceFeatures) -> Self

Includes the payee’s features.

(C-not exported) since bindings don’t support move semantics

pub fn with_route_hints(self, route_hints: Vec<RouteHint>) -> Self

Includes hints for routing to the payee.

(C-not exported) since bindings don’t support move semantics

pub fn with_expiry_time(self, expiry_time: u64) -> Self

Includes a payment expiration in seconds relative to the UNIX epoch.

(C-not exported) since bindings don’t support move semantics

Trait Implementations

impl Clone for Payee

fn clone(&self) -> Payee

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payee

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

Formats the value using the given formatter.

impl Hash for Payee

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Payee> for Payee

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

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

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

This method tests for !=.

impl Readable for Payee

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read

impl Writeable for Payee

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Writes self out to the given Writer

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

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

Writes self out to a Vec

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

Writes self out to a Vec

impl Eq for Payee

impl StructuralEq for Payee

impl StructuralPartialEq for Payee