Struct ZcashAddress

pub struct ZcashAddress { /* private fields */ }

A Zcash address.

Implementations

impl ZcashAddress

pub fn encode(&self) -> String

Encodes this Zcash address in its canonical string representation.

This provides the encoded string representation of the address as defined by the Zcash protocol specification and/or ZIP 316. The Display implementation can also be used to produce this encoding using address.to_string().

pub fn try_from_encoded(s: &str) -> Result<Self, ParseError>

Attempts to parse the given string as a Zcash address.

This simply calls s.parse(), leveraging the FromStr implementation.

Errors

• If the parser can detect that the string must contain an address encoding used by Zcash, ParseError::InvalidEncoding will be returned if any subsequent part of that encoding is invalid.

• In all other cases, ParseError::NotZcash will be returned on failure.

Examples

use zcash_address::ZcashAddress;

let encoded = "zs1z7rejlpsa98s2rrrfkwmaxu53e4ue0ulcrw0h4x5g8jl04tak0d3mm47vdtahatqrlkngh9sly";
let addr = ZcashAddress::try_from_encoded(&encoded);
assert_eq!(encoded.parse(), addr);

pub fn convert<T: TryFromAddress>(self) -> Result<T, ConversionError<T::Error>>

Converts this address into another type.

convert can convert into any type that implements the TryFromAddress trait. This enables ZcashAddress to be used as a common parsing and serialization interface for Zcash addresses, while delegating operations on those addresses (such as constructing transactions) to downstream crates.

If you want to get the encoded string for this address, use the encode method or the Display implementation via address.to_string() instead.

pub fn convert_if_network<T: TryFromRawAddress>( self, net: NetworkType, ) -> Result<T, ConversionError<T::Error>>

Converts this address into another type, if it matches the expected network.

convert_if_network can convert into any type that implements the TryFromRawAddress trait. This enables ZcashAddress to be used as a common parsing and serialization interface for Zcash addresses, while delegating operations on those addresses (such as constructing transactions) to downstream crates.

If you want to get the encoded string for this address, use the encode method or the Display implementation via address.to_string() instead.

pub fn convert_with<T, C: Converter<T>>( self, converter: C, ) -> Result<T, ConversionError<C::Error>>

Converts this address into another type using the specified converter.

convert can convert into any type T for which an implementation of the Converter<T> trait exists. This enables conversion of ZcashAddress values into other types to rely on additional context.

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

Returns whether this address has the ability to receive transfers of the given pool type.

pub fn can_receive_memo(&self) -> bool

Returns whether this address can receive a memo.

pub fn matches_receiver(&self, receiver: &Receiver) -> bool

Returns whether or not this address contains or corresponds to the given unified address receiver.

Trait Implementations

impl Clone for ZcashAddress

fn clone(&self) -> ZcashAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ZcashAddress

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

Formats the value using the given formatter.

impl Display for ZcashAddress

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

Formats the value using the given formatter.

impl FromStr for ZcashAddress

fn from_str(s: &str) -> Result<Self, Self::Err>

Attempts to parse the given string as a Zcash address.

type Err = ParseError

The associated error which can be returned from parsing.

impl Hash for ZcashAddress

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ZcashAddress

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

fn from_sprout(net: NetworkType, data: [u8; 64]) -> Self

fn from_sapling(net: NetworkType, data: [u8; 43]) -> Self

fn from_unified(net: NetworkType, data: Address) -> Self

fn from_transparent_p2pkh(net: NetworkType, data: [u8; 20]) -> Self

fn from_transparent_p2sh(net: NetworkType, data: [u8; 20]) -> Self

fn from_tex(net: NetworkType, data: [u8; 20]) -> Self

impl Eq for ZcashAddress

impl StructuralPartialEq for ZcashAddress