Struct lightning_invoice::Description

pub struct Description(/* private fields */);

Description string

Invariants

The description can be at most 639 bytes long

Implementations

impl Description

pub fn new(description: String) -> Result<Description, CreationError>

Creates a new Description if description is at most 1023 * 5 bits (i.e., 639 bytes) long, and returns CreationError::DescriptionTooLong otherwise.

Please note that single characters may use more than one byte due to UTF8 encoding.

pub fn into_inner(self) -> UntrustedString

Returns the underlying description UntrustedString

pub fn as_inner(&self) -> &UntrustedString

Get a reference to the underlying description UntrustedString

Trait Implementations

impl Base32Len for Description

fn base32_len(&self) -> usize

Calculate the base32 serialized length

impl Clone for Description

fn clone(&self) -> Description

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Description

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

Formats the value using the given formatter.

impl Default for Description

fn default() -> Description

Returns the “default value” for a type.

impl Display for Description

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

Formats the value using the given formatter.

impl FromBase32 for Description

type Err = Bolt11ParseError

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

fn from_base32(field_data: &[u5]) -> Result<Description, Bolt11ParseError>

Convert a base32 slice to Self.

impl Hash for Description

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 Description

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

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

fn partial_cmp(&self, other: &Description) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl ToBase32 for Description

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 Description

impl StructuralPartialEq for Description