Struct lightning_invoice::RawInvoice

pub struct RawInvoice {
    pub hrp: RawHrp,
    pub data: RawDataPart,
}

Represents an syntactically correct Invoice for a payment on the lightning network, but without the signature information. De- and encoding should not lead to information loss but may lead to different hashes.

For methods without docs see the corresponding methods in Invoice.

Fields

hrp: RawHrp

human readable part

data: RawDataPart

data part

Methods

impl RawInvoice

pub fn hash(&self) -> [u8; 32]

Calculate the hash of the encoded RawInvoice

pub fn sign<F, E>(self, sign_method: F) -> Result<SignedRawInvoice, E> where     F: FnOnce(&Message) -> Result<RecoverableSignature, E>,

Signs the invoice using the supplied sign_function. This function MAY fail with an error of type E. Since the signature of a SignedRawInvoice is not required to be valid there are no constraints regarding the validity of the produced signature.

pub fn known_tagged_fields(     &self ) -> FilterMap<Iter<RawTaggedField>, fn(_: &RawTaggedField) -> Option<&TaggedField>>

Returns an iterator over all tagged fields with known semantics.

pub fn payment_hash(&self) -> Option<&Sha256>

pub fn description(&self) -> Option<&Description>

pub fn payee_pub_key(&self) -> Option<&PayeePubKey>

pub fn description_hash(&self) -> Option<&Sha256>

pub fn expiry_time(&self) -> Option<&ExpiryTime>

pub fn min_final_cltv_expiry(&self) -> Option<&MinFinalCltvExpiry>

pub fn fallbacks(&self) -> Vec<&Fallback>

pub fn routes(&self) -> Vec<&Route>

pub fn amount_pico_btc(&self) -> Option<u64>

pub fn currency(&self) -> Currency

Trait Implementations

impl Eq for RawInvoice

impl PartialEq<RawInvoice> for RawInvoice

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

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

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

This method tests for !=.

impl Clone for RawInvoice

fn clone(&self) -> RawInvoice

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawInvoice

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

Formats the value using the given formatter.