Enum lightning_invoice::SemanticError

source · [−]

pub enum SemanticError {
    NoPaymentHash,
    MultiplePaymentHashes,
    NoDescription,
    MultipleDescriptions,
    NoPaymentSecret,
    MultiplePaymentSecrets,
    InvalidFeatures,
    InvalidRecoveryId,
    InvalidSignature,
    ImpreciseAmount,
}

Expand description

Errors that may occur when converting a RawInvoice to an Invoice. They relate to the requirements sections in BOLT #11

Variants

`NoPaymentHash`

The invoice is missing the mandatory payment hash

`MultiplePaymentHashes`

The invoice has multiple payment hashes which isn’t allowed

`NoDescription`

No description or description hash are part of the invoice

`MultipleDescriptions`

The invoice contains multiple descriptions and/or description hashes which isn’t allowed

`NoPaymentSecret`

The invoice is missing the mandatory payment secret, which all modern lightning nodes should provide.

`MultiplePaymentSecrets`

The invoice contains multiple payment secrets

`InvalidFeatures`

The invoice’s features are invalid

`InvalidRecoveryId`

The recovery id doesn’t fit the signature/pub key

`InvalidSignature`

The invoice’s signature is invalid

`ImpreciseAmount`

The invoice’s amount was not a whole number of millisatoshis

Trait Implementations

impl Clone for SemanticError

fn clone(&self) -> SemanticError

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for SemanticError

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

Formats the value using the given formatter. Read more

impl Display for SemanticError

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

Formats the value using the given formatter. Read more

impl Error for SemanticError

This is supported on crate feature std only.

1.30.0 · source

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more

fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred. Read more

1.0.0 · source

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · source

fn cause(&self) -> Option<&dyn Error>

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl From<SemanticError> for ParseOrSemanticError

fn from(e: SemanticError) -> Self

Performs the conversion.

impl PartialEq<SemanticError> for SemanticError

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

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

1.0.0 · source

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

This method tests for !=.

impl Eq for SemanticError

impl StructuralEq for SemanticError

impl StructuralPartialEq for SemanticError

Auto Trait Implementations

impl RefUnwindSafe for SemanticError

impl Send for SemanticError

impl Sync for SemanticError

impl Unpin for SemanticError

impl UnwindSafe for SemanticError

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T where
T: Display + ?Sized,

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.