Struct bip21::Uri

#[non_exhaustive]
pub struct Uri<'a, Extras = NoExtras> {
    pub address: Address,
    pub amount: Option<Amount>,
    pub label: Option<Param<'a>>,
    pub message: Option<Param<'a>>,
    pub extras: Extras,
}

Parsed BIP21 URI.

This struct represents all fields of BIP21 URI with the ability to add more extra fields using the extras field. By default there are no extra fields so an empty implementation is used.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: Address

The address provided in the URI.

This field is mandatory because the address is mandatory in BIP21.

amount: Option<Amount>

Number of satoshis requested as payment.

label: Option<Param<'a>>

The label of the address - e.g. name of the receiver.

message: Option<Param<'a>>

Message that describes the transaction to the user.

extras: Extras

Extra fields that can occur in a BIP21 URI.

Implementations

impl<'a, T> Uri<'a, T>

pub fn new(address: Address) -> Selfwhere
    T: Default,

Creates an URI with defaults.

This sets all fields except address to default values. They can be overwritten in subsequent assignments before displaying the URI.

pub fn with_extras(address: Address, extras: T) -> Self

Creates an URI with defaults.

This sets all fields except address and extras to default values. They can be overwritten in subsequent assignments before displaying the URI.

Trait Implementations

impl<'a, Extras: Debug> Debug for Uri<'a, Extras>

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

Formats the value using the given formatter.

impl<'a, T> Display for Uri<'a, T>where
    for<'b> &'b T: SerializeParams,

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

Formats the value using the given formatter.

impl<'a, T> FromStr for Uri<'a, T>where
    for<'de> T: DeserializeParams<'de>,

Warning: this implementation may needlessly allocate, consider using TryFrom<&str> instead.

type Err = Error<<T as DeserializationError>::Error>

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'a, T> TryFrom<&'a str> for Uri<'a, T>where
    T: DeserializeParams<'a>,

type Error = Error<<T as DeserializationError>::Error>

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T> TryFrom<Cow<'a, str>> for Uri<'a, T>where
    T: for<'de> DeserializeParams<'de>,

Warning: this implementation may needlessly allocate, consider using TryFrom<&str> instead.

type Error = Error<<T as DeserializationError>::Error>

The type returned in the event of a conversion error.

fn try_from(s: Cow<'a, str>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, T> TryFrom<String> for Uri<'a, T>where
    for<'de> T: DeserializeParams<'de>,

Warning: this implementation may needlessly allocate, consider using TryFrom<&str> instead.

type Error = Error<<T as DeserializationError>::Error>

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, Self::Error>

Performs the conversion.