Enum Address

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

An address that funds can be sent to.

Variants

Sapling(PaymentAddress)

A Sapling payment address.

Transparent(TransparentAddress)

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

Unified(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(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<P>(&self, params: &P) -> ZcashAddress

where P: Parameters,

Converts this Address to its encoded [ZcashAddress] representation.

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

where P: Parameters,

Converts this Address to its encoded string representation.

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.

Trait Implementations

impl Clone for Address

fn clone(&self) -> Address

Returns a copy 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 From<PaymentAddress> for Address

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

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 TryFromRawAddress for Address

type Error = &'static str

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

fn try_from_raw_sapling( data: [u8; 43], ) -> Result<Address, ConversionError<<Address as TryFromRawAddress>::Error>>

fn try_from_raw_unified( ua: Address, ) -> Result<Address, ConversionError<<Address as TryFromRawAddress>::Error>>

fn try_from_raw_transparent_p2pkh( data: [u8; 20], ) -> Result<Address, ConversionError<<Address as TryFromRawAddress>::Error>>

fn try_from_raw_transparent_p2sh( data: [u8; 20], ) -> Result<Address, ConversionError<<Address as TryFromRawAddress>::Error>>

fn try_from_raw_tex( data: [u8; 20], ) -> Result<Address, ConversionError<<Address as TryFromRawAddress>::Error>>

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

impl Eq for Address

impl StructuralPartialEq for Address