Enum invoice::Beneficiary

#[non_exhaustive]
pub enum Beneficiary {
    Address(Address),
    BlindUtxo(ConcealedSeal),
    Descriptor(Descriptor<DescriptorPublicKey>),
    Psbt(Psbt),
    Bolt(LnAddress),
    Unknown(Blob),
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Address(Address)

Addresses are useful when you do not like to leak public key information

BlindUtxo(ConcealedSeal)

Used by protocols that work with existing UTXOs and can assign some client-validated data to them (like in RGB). We always hide the real UTXO behind the hashed version (using some salt)

Descriptor(Descriptor<DescriptorPublicKey>)

Miniscript-based descriptors allowing custom derivation & key generation

Psbt(Psbt)

Full transaction template in PSBT format

Bolt(LnAddress)

Lightning node receiving the payment. Not the same as lightning invoice since many of the invoice data now will be part of Invoice here.

Unknown(Blob)

Fallback option for all future variants

Trait Implementations

impl Clone for Beneficiary

fn clone(&self) -> Beneficiary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Beneficiary

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

Formats the value using the given formatter.

impl Display for Beneficiary

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

Formats the value using the given formatter.

impl From<Address> for Beneficiary

fn from(v: Address) -> Self

Converts to this type from the input type.

impl From<ConcealedSeal> for Beneficiary

fn from(v: ConcealedSeal) -> Self

Converts to this type from the input type.

impl From<Descriptor<DescriptorPublicKey>> for Beneficiary

fn from(v: Descriptor<DescriptorPublicKey>) -> Self

Converts to this type from the input type.

impl From<LnAddress> for Beneficiary

fn from(v: LnAddress) -> Self

Converts to this type from the input type.

impl From<Psbt> for Beneficiary

fn from(v: Psbt) -> Self

Converts to this type from the input type.

impl FromStr for Beneficiary

type Err = BeneficiaryParseError

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 PartialEq<Beneficiary> for Beneficiary

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

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for Beneficiary

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8, Global>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl Eq for Beneficiary

impl StructuralEq for Beneficiary

impl StructuralPartialEq for Beneficiary