Struct lightning_invoice::Description

pub struct Description(_);

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 bytes long, returns CreationError::DescriptionTooLong otherwise

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

pub fn into_inner(self) -> String

Returns the underlying description String

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 Deref for Description

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl Eq for Description

impl FromBase32 for Description

type Err = ParseError

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

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

Convert a base32 slice to Self.

impl Into<String> for Description

fn into(self) -> String

Performs the conversion.

impl PartialEq<Description> for Description

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

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

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

This method tests for !=.

impl StructuralEq for Description

impl StructuralPartialEq for Description

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