Struct Payment

pub struct Payment { /* private fields */ }

A single payment being requested.

Implementations

impl Payment

pub fn new( recipient_address: ZcashAddress, amount: Zatoshis, memo: Option<MemoBytes>, label: Option<String>, message: Option<String>, other_params: Vec<(String, String)>, ) -> Option<Payment>

Constructs a new Payment from its constituent parts.

Returns None if the payment requests that a memo be sent to a recipient that cannot receive a memo.

pub fn without_memo( recipient_address: ZcashAddress, amount: Zatoshis, ) -> Payment

Constructs a new Payment paying the given address the specified amount.

pub fn recipient_address(&self) -> &ZcashAddress

Returns the payment address to which the payment should be sent.

pub fn amount(&self) -> Zatoshis

Returns the value of the payment that is being requested, in zatoshis.

pub fn memo(&self) -> Option<&MemoBytes>

Returns the memo that, if included, must be provided with the payment.

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

A human-readable label for this payment within the larger structure of the transaction request.

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

A human-readable message to be displayed to the user describing the purpose of this payment.

pub fn other_params(&self) -> &[(String, String)]

A list of other arbitrary key/value pairs associated with this payment.

Trait Implementations

impl Clone for Payment

fn clone(&self) -> Payment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Payment

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

Formats the value using the given formatter.

impl PartialEq for Payment

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

impl StructuralPartialEq for Payment