Struct Invoice 

pub struct Invoice { /* private fields */ }

NB: Invoice fields are non-public since each time we update them we must clear signature

Implementations

impl Invoice

pub fn version(&self) -> &u8

Method borrowing Invoice::version field. Version byte, always 0 for the initial version

pub fn amount(&self) -> &AmountExt

Method borrowing Invoice::amount field. Amount in the specified asset - a price per single item, if quantity

pub fn beneficiary(&self) -> &Beneficiary

Method borrowing Invoice::beneficiary field. Main beneficiary. Separating the first beneficiary into a standalone

pub fn alt_beneficiaries(&self) -> &Vec<Beneficiary>

Method borrowing Invoice::alt_beneficiaries field. List of beneficiary ordered in most desirable-first order, which follow

pub fn asset(&self) -> &Option<AssetId>

Method borrowing Invoice::asset field. AssetId can also be used to define blockchain. If it’s empty it implies

pub fn expiry(&self) -> &Option<NaiveDateTime>

Method borrowing Invoice::expiry field.

pub fn recurrent(&self) -> &Recurrent

Method borrowing Invoice::recurrent field. Interval between recurrent payments

pub fn quantity(&self) -> &Option<Quantity>

Method borrowing Invoice::quantity field.

pub fn currency_requirement(&self) -> &Option<CurrencyData>

Method borrowing Invoice::currency_requirement field. If the price of the asset provided by fiat provider URL goes below this

pub fn merchant(&self) -> &Option<String>

Method borrowing Invoice::merchant field.

pub fn purpose(&self) -> &Option<String>

Method borrowing Invoice::purpose field.

pub fn details(&self) -> &Option<Details>

Method borrowing Invoice::details field.

pub fn signature(&self) -> &Option<(PublicKey, Signature)>

Method borrowing Invoice::signature field.

pub fn consignment_endpoints(&self) -> &Vec<ConsignmentEndpoint>

Method borrowing Invoice::consignment_endpoints field. List of nodes which are able to accept RGB consignment

pub fn unknown(&self) -> &Stream

Method borrowing Invoice::unknown field.

impl Invoice

pub fn new( beneficiary: Beneficiary, amount: Option<u64>, asset: Option<AssetId>, ) -> Invoice

pub fn with_descriptor( descr: Descriptor<DescriptorPublicKey>, amount: Option<u64>, chain: &Chain, ) -> Invoice

pub fn with_address(address: Address, amount: Option<u64>) -> Invoice

pub fn classify_asset(&self, chain: Option<Chain>) -> AssetClass

pub fn beneficiaries(&self) -> BeneficiariesIter<'_>

pub fn set_amount(&mut self, amount: AmountExt) -> bool

pub fn set_recurrent(&mut self, recurrent: Recurrent) -> bool

pub fn set_expiry(&mut self, expiry: NaiveDateTime) -> bool

pub fn set_no_expiry(&mut self) -> bool

pub fn set_quantity(&mut self, quantity: Quantity) -> bool

pub fn remove_quantity(&mut self) -> bool

pub fn set_currency_requirement(&mut self, currency_data: CurrencyData) -> bool

pub fn remove_currency_requirement(&mut self) -> bool

pub fn set_merchant(&mut self, merchant: String) -> bool

pub fn remove_merchant(&mut self) -> bool

pub fn set_purpose(&mut self, purpose: String) -> bool

pub fn remove_purpose(&mut self) -> bool

pub fn set_details(&mut self, details: Details) -> bool

pub fn remove_details(&mut self) -> bool

pub fn signature_hash(&self) -> MerkleNode

pub fn set_signature(&mut self, pubkey: PublicKey, signature: Signature)

pub fn remove_signature(&mut self)

Trait Implementations

impl Clone for Invoice

fn clone(&self) -> Invoice

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invoice

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

Formats the value using the given formatter.

impl Display for Invoice

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

Formats the value using the given formatter.

impl FromStr for Invoice

type Err = 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 Ord for Invoice

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

Restrict a value to a certain interval.

impl PartialEq for Invoice

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

fn partial_cmp(&self, other: &Self) -> 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 Strategy for Invoice

const HRP: &'static str = "i"

Bech32 HRP prefix used by a type

type Strategy = CompressedStrictEncoding

Specific strategy used for automatic implementation of all Bech32-related traits.

impl StrictDecode for Invoice

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 Invoice

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>, 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 Invoice

impl StructuralPartialEq for Invoice