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. Decoding 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

Implementations

impl RawInvoice

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

Calculate the hash of the encoded RawInvoice which should be signed.

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_method. 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.

This is not exported to bindings users as we don’t currently support passing function pointers into methods explicitly.

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

Returns an iterator over all tagged fields with known semantics.

This is not exported to bindings users as there is not yet a manual mapping for a FilterMap

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_delta(&self) -> Option<&MinFinalCltvExpiryDelta>

pub fn payment_secret(&self) -> Option<&PaymentSecret>

pub fn payment_metadata(&self) -> Option<&Vec<u8>>

pub fn features(&self) -> Option<&InvoiceFeatures>

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

This is not exported to bindings users as we don’t support Vec<&NonOpaqueType>

pub fn private_routes(&self) -> Vec<&PrivateRoute>

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

pub fn currency(&self) -> Currency

Trait Implementations

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.

impl Hash for RawInvoice

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 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: &Rhs) -> bool

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

impl Eq for RawInvoice

impl StructuralEq for RawInvoice

impl StructuralPartialEq for RawInvoice