Enum lightning_invoice::TaggedField

pub enum TaggedField {
    PaymentHash(Sha256),
    Description(Description),
    PayeePubKey(PayeePubKey),
    DescriptionHash(Sha256),
    ExpiryTime(ExpiryTime),
    MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta),
    Fallback(Fallback),
    PrivateRoute(PrivateRoute),
    PaymentSecret(PaymentSecret),
    PaymentMetadata(Vec<u8>),
    Features(Bolt11InvoiceFeatures),
}

Tagged field with known tag

For descriptions of the enum values please refer to the enclosed type’s docs.

This is not exported to bindings users as we don’t yet support enum variants with the same name the struct contained in the variant.

Variants

PaymentHash(Sha256)

Description(Description)

PayeePubKey(PayeePubKey)

DescriptionHash(Sha256)

ExpiryTime(ExpiryTime)

MinFinalCltvExpiryDelta(MinFinalCltvExpiryDelta)

Fallback(Fallback)

PrivateRoute(PrivateRoute)

PaymentSecret(PaymentSecret)

PaymentMetadata(Vec<u8>)

Features(Bolt11InvoiceFeatures)

Implementations

impl TaggedField

pub fn tag(&self) -> u5

Numeric representation of the field’s tag

Trait Implementations

impl Clone for TaggedField

fn clone(&self) -> TaggedField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaggedField

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

Formats the value using the given formatter.

impl From<TaggedField> for RawTaggedField

fn from(tf: TaggedField) -> Self

Converts to this type from the input type.

impl FromBase32 for TaggedField

type Err = Bolt11ParseError

The associated error which can be returned from parsing (e.g. because of bad padding).

fn from_base32(field: &[u5]) -> Result<TaggedField, Bolt11ParseError>

Convert a base32 slice to Self.

impl Hash for TaggedField

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 Ord for TaggedField

fn cmp(&self, other: &TaggedField) -> 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 PartialEq for TaggedField

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

fn partial_cmp(&self, other: &TaggedField) -> 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 ToBase32 for TaggedField

fn write_base32<W: WriteBase32>( &self, writer: &mut W ) -> Result<(), <W as WriteBase32>::Err>

Encode as base32 and write it to the supplied writer Implementations shouldn’t allocate.

fn to_base32(&self) -> Vec<u5>

Convert Self to base32 vector

impl Eq for TaggedField

impl StructuralPartialEq for TaggedField