Struct ReceiveInstructions 

pub struct ReceiveInstructions { /* private fields */ }

Parsed receive instructions representing a set of possible ways to receive, as well as an associated description.

It supports:

• Raw WIF encoded private keys (which should be swept)
• Lightning Bolt 12 Refunds

Implementations

impl ReceiveInstructions

pub fn methods(&self) -> &[ReceiveMethod]

The list of ReceiveMethods.

pub fn sender_description(&self) -> Option<&str>

A sender-provided description of the payment instructions.

This may be:

• the description field in a lightning BOLT 12 offer

pub fn parse_receive_instructions( instructions: &str, network: Network, ) -> Result<ReceiveInstructions, ParseError>

Resolves a string into ReceiveInstructions. Verifying it is valid for the given network

Trait Implementations

impl Clone for ReceiveInstructions

fn clone(&self) -> ReceiveInstructions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReceiveInstructions

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

Formats the value using the given formatter.

impl PartialEq for ReceiveInstructions

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

impl StructuralPartialEq for ReceiveInstructions