Skip to main content

LnurlPayRequestMetadata

Struct LnurlPayRequestMetadata 

Source
pub struct LnurlPayRequestMetadata {
    pub description: String,
    pub long_description: Option<String>,
    pub image_png_base64: Option<String>,
    pub image_jpeg_base64: Option<String>,
    pub identifier: Option<String>,
    pub email: Option<String>,
    pub description_hash: [u8; 32],
    pub raw: String,
}
Expand description

The metadata inside a LnurlPayRequest.

Fields§

§description: String

Short description from text/plain (required, LUD-06).

§long_description: Option<String>

Long description from text/long-desc (optional, LUD-06). Can be displayed to the user when prompting the user for an amount.

§image_png_base64: Option<String>

PNG thumbnail from image/png;base64 (optional, LUD-06). Can be displayed to the user when prompting the user for an amount.

§image_jpeg_base64: Option<String>

JPEG thumbnail from image/jpeg;base64 (optional, LUD-06). Can be displayed to the user when prompting the user for an amount.

§identifier: Option<String>

Internet identifier from text/identifier (LUD-16). LNURL-Pay via LUD-16 requires this or text/email to be set.

§email: Option<String>

Email address from text/email (LUD-16). LNURL-Pay via LUD-16 requires this or text/identifier to be set.

§description_hash: [u8; 32]

SHA256 hash of raw metadata for invoice validation.

§raw: String

The original unparsed metadata string.

Implementations§

Source§

impl LnurlPayRequestMetadata

Source

pub fn from_email(email: &str) -> LnurlPayRequestMetadata

Source

pub fn from_raw_string(raw: String) -> Result<LnurlPayRequestMetadata, Error>

Parses LNURL-pay metadata string into structured metadata.

LUD-06 metadata field is a JSON array encoded as a string: "[[\"text/plain\", \"lorem ipsum blah blah\"]]".

Source

pub fn to_raw_string(&self) -> String

Serializes the metadata back into the raw LNURL-pay metadata string.

Generates a JSON array encoded as a string, suitable for use in LNURL-pay requests. The order of entries is deterministic.

Trait Implementations§

Source§

impl Clone for LnurlPayRequestMetadata

Source§

fn clone(&self) -> LnurlPayRequestMetadata

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LnurlPayRequestMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for LnurlPayRequestMetadata

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for LnurlPayRequestMetadata

Source§

impl StructuralPartialEq for LnurlPayRequestMetadata

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<F, T, U> Apply<F, U> for T
where F: FnOnce(T) -> U,

Source§

fn apply(self, f: F) -> U

Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more