Struct TransactionRequest

pub struct TransactionRequest { /* private fields */ }

A ZIP321 transaction request.

A ZIP 321 request may include one or more such requests for payment. When constructing a transaction in response to such a request, a separate output should be added to the transaction for each payment value in the request.

Implementations

impl TransactionRequest

pub fn empty() -> Self

Constructs a new empty transaction request.

pub fn new(payments: Vec<Payment>) -> Result<TransactionRequest, Zip321Error>

Constructs a new transaction request that obeys the ZIP-321 invariants.

pub fn from_indexed( payments: BTreeMap<usize, Payment>, ) -> Result<TransactionRequest, Zip321Error>

Constructs a new transaction request from the provided map from payment index to payment.

Payment index 0 will be mapped to the empty payment index.

pub fn payments(&self) -> &BTreeMap<usize, Payment>

Returns the map of payments that make up this request.

This is a map from payment index to payment. Payment index 0 is used to denote the empty payment index in the returned values.

pub fn total(&self) -> Result<Zatoshis, BalanceError>

Returns the total value of payments to be made.

Returns Err in the case of overflow, or if the value is outside the range 0..=MAX_MONEY zatoshis.

pub fn to_uri(&self) -> String

Convert this request to a URI string.

Returns None if the payment request is empty.

pub fn from_uri(uri: &str) -> Result<Self, Zip321Error>

Parse the provided URI to a payment request value.

Trait Implementations

impl Clone for TransactionRequest

fn clone(&self) -> TransactionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionRequest

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

Formats the value using the given formatter.

impl PartialEq for TransactionRequest

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

impl StructuralPartialEq for TransactionRequest