Enum lightning_invoice::Bolt11InvoiceDescription

pub enum Bolt11InvoiceDescription<'f> {
    Direct(&'f Description),
    Hash(&'f Sha256),
}

Represents the description of an invoice which has to be either a directly included string or a hash of a description provided out of band.

This is not exported to bindings users as we don’t have a good way to map the reference lifetimes making this practically impossible to use safely in languages like C.

Variants

Direct(&'f Description)

Reference to the directly supplied description in the invoice

Hash(&'f Sha256)

Reference to the description’s hash included in the invoice

Trait Implementations

impl<'f> Clone for Bolt11InvoiceDescription<'f>

fn clone(&self) -> Bolt11InvoiceDescription<'f>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'f> Debug for Bolt11InvoiceDescription<'f>

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

Formats the value using the given formatter.

impl<'f> Ord for Bolt11InvoiceDescription<'f>

fn cmp(&self, other: &Bolt11InvoiceDescription<'f>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'f> PartialEq for Bolt11InvoiceDescription<'f>

fn eq(&self, other: &Bolt11InvoiceDescription<'f>) -> 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<'f> PartialOrd for Bolt11InvoiceDescription<'f>

fn partial_cmp(&self, other: &Bolt11InvoiceDescription<'f>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'f> Eq for Bolt11InvoiceDescription<'f>

impl<'f> StructuralEq for Bolt11InvoiceDescription<'f>

impl<'f> StructuralPartialEq for Bolt11InvoiceDescription<'f>