Enum Invoice

pub enum Invoice {
    Bolt11(Bolt11Invoice),
    Bolt12(Bolt12Invoice),
}

Enum to represent either a lightning Bolt11Invoice or a Bolt12Invoice.

Variants

Bolt11(Bolt11Invoice)

Bolt12(Bolt12Invoice)

Implementations

impl Invoice

pub fn into_bolt11(self) -> Option<Bolt11Invoice>

pub fn payment_hash(&self) -> PaymentHash

pub fn network(&self) -> Network

pub fn get_final_amount( &self, user_amount: Option<Amount>, ) -> Result<Amount, CheckAmountError>

Get the amount to be paid. It checks both user and invoice equality if both are provided, else it tries to return one of them, or returns an error if neither are provided.

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

pub fn check_signature(&self) -> Result<(), CheckSignatureError>

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invoice

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Invoice

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Invoice

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

Formats the value using the given formatter.

impl From<Bolt11Invoice> for Invoice

fn from(invoice: Bolt11Invoice) -> Self

Converts to this type from the input type.

impl From<Bolt12Invoice> for Invoice

fn from(invoice: Bolt12Invoice) -> Self

Converts to this type from the input type.

impl FromStr for Invoice

type Err = InvoiceParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Invoice

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 for Invoice

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

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a str> for Invoice

type Error = <Invoice as FromStr>::Err

The type returned in the event of a conversion error.

fn try_from(invoice: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Invoice

type Error = <Invoice as FromStr>::Err

The type returned in the event of a conversion error.

fn try_from(invoice: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Invoice

impl StructuralPartialEq for Invoice