Enum Address 

pub enum Address {
    Sapling(Box<PaymentAddress>),
    Transparent(TransparentAddress),
    Unified(Box<UnifiedAddress>),
    Tex([u8; 20]),
}

An address that funds can be sent to.

Variants

Sapling(Box<PaymentAddress>)

Available on crate feature sapling only.

A Sapling payment address.

Transparent(TransparentAddress)

A transparent address corresponding to either a public key hash or a script hash.

Unified(Box<UnifiedAddress>)

A ZIP 316 Unified Address.

Tex([u8; 20])

A ZIP 320 transparent-source-only P2PKH address, or “TEX address”.

Implementations

impl Address

pub fn decode<P>(params: &P, s: &str) -> Option<Address>

where P: Parameters,

Attempts to decode an Address value from its ZcashAddress encoded representation.

Returns None if any error is encountered in decoding. Use Self::try_from_zcash_address passing in s.parse()? if you need detailed error information.

pub fn try_from_zcash_address<P>( params: &P, zaddr: ZcashAddress, ) -> Result<Address, ConversionError<&'static str>>

where P: Parameters,

Attempts to decode an Address value from its ZcashAddress encoded representation.

pub fn to_zcash_address_revision<P>( &self, params: &P, ua_revision: Revision, ) -> Result<ZcashAddress, UnifiedEncodingError>

where P: Parameters,

Converts this Address to a ZcashAddress.

A unified address is encoded with every receiver and metadata item, at the given ZIP 316 revision. Sapling, transparent, and TEX addresses have a single encoding and ignore ua_revision.

Returns UnifiedEncodingError::NotRepresentable if this is a unified address that ua_revision cannot encode in full. Revision::R0 cannot encode expiry metadata or an address whose only receiver is transparent; every address has a Revision::R2 encoding.

pub fn to_zcash_address<P>(&self, params: &P) -> ZcashAddress

where P: Parameters,

Converts this Address to a ZcashAddress.

A unified address is encoded with every receiver and metadata item, at ZIP 316 Revision::R0 if that revision can represent it, and at Revision::R2 otherwise. Sapling, transparent, and TEX addresses have a single encoding.

pub fn encode<P>(&self, params: &P) -> String

where P: Parameters,

Returns the string encoding of this Address.

A unified address is encoded with every receiver and metadata item, at ZIP 316 Revision::R0 if that revision can represent it, and at Revision::R2 otherwise. Sapling, transparent, and TEX addresses have a single encoding.

pub fn encode_revision<P>( &self, params: &P, ua_revision: Revision, ) -> Result<String, UnifiedEncodingError>

where P: Parameters,

Returns the string encoding of this Address.

A unified address is encoded with every receiver and metadata item, at the given ZIP 316 revision. Sapling, transparent, and TEX addresses have a single encoding and ignore ua_revision.

Returns UnifiedEncodingError::NotRepresentable if this is a unified address that ua_revision cannot encode in full. Revision::R0 cannot encode expiry metadata or an address whose only receiver is transparent; every address has a Revision::R2 encoding.

pub fn can_receive_as(&self, pool_type: PoolType) -> bool

Returns whether or not this Address can receive funds in the specified pool.

pub fn to_transparent_address(&self) -> Option<TransparentAddress>

Returns the transparent address corresponding to this address, if it is a transparent address, a Unified address with a transparent receiver, or ZIP 320 (TEX) address.

pub fn to_sapling_address(&self) -> Option<PaymentAddress>

Available on crate feature sapling only.

Returns the Sapling address corresponding to this address, if it is a ZIP 32-encoded Sapling address, or a Unified address with a Sapling receiver.

pub fn as_understood_unified_receivers(&self) -> Vec<Receiver>

Returns the protocol-typed unified Receivers of this address as a vector, ignoring the original encoding of the address.

In the case that the underlying address is the Address::Unified variant, this is equivalent to UnifiedAddress::as_understood_receivers in that it does not return unknown receiver data.

Note that this method eliminates the distinction between transparent addresses and the transparent receiving address for a TEX address; as such, it should only be used in cases where address uses are being detected in inspection of chain data, and NOT in any situation where a transaction sending to this address is being constructed.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Address

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

Formats the value using the given formatter.

impl Eq for Address

impl From<PaymentAddress> for Address

Available on crate feature sapling only.

fn from(addr: PaymentAddress) -> Address

Converts to this type from the input type.

impl From<TransparentAddress> for Address

fn from(addr: TransparentAddress) -> Address

Converts to this type from the input type.

impl From<UnifiedAddress> for Address

fn from(addr: UnifiedAddress) -> Address

Converts to this type from the input type.

impl PartialEq for Address

fn eq(&self, other: &Address) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Address

impl TryFromAddress for Address

type Error = &'static str

Conversion errors for the user type (e.g. failing to parse the data passed to Self::try_from_sapling as a valid Sapling address).

fn try_from_sapling( _net: NetworkType, data: [u8; 43], ) -> Result<Address, ConversionError<<Address as TryFromAddress>::Error>>

fn try_from_unified( _net: NetworkType, ua: Address, ) -> Result<Address, ConversionError<<Address as TryFromAddress>::Error>>

fn try_from_transparent_p2pkh( _net: NetworkType, data: [u8; 20], ) -> Result<Address, ConversionError<<Address as TryFromAddress>::Error>>

fn try_from_transparent_p2sh( _net: NetworkType, data: [u8; 20], ) -> Result<Address, ConversionError<<Address as TryFromAddress>::Error>>

fn try_from_tex( _net: NetworkType, data: [u8; 20], ) -> Result<Address, ConversionError<<Address as TryFromAddress>::Error>>

fn try_from_sprout( net: NetworkType, data: [u8; 64], ) -> Result<Self, ConversionError<Self::Error>>