Struct Ufvk

pub struct Ufvk(/* private fields */);

A Unified Full Viewing Key.

Examples

use zcash_address::unified::{self, Container, Encoding};

let example_ufvk: &str = ufvk_from_user();

let (network, ufvk) = unified::Ufvk::decode(example_ufvk)?;

// We can obtain the pool-specific Full Viewing Keys for the UFVK in preference
// order (the order in which wallets should prefer to use their corresponding
// address receivers):
let fvks: Vec<unified::Fvk> = ufvk.items();

// And we can create the UFVK from a list of FVKs:
let new_ufvk = unified::Ufvk::try_from_items(fvks)?;
assert_eq!(new_ufvk, ufvk);

Trait Implementations

impl Clone for Ufvk

fn clone(&self) -> Ufvk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Container for Ufvk

fn items_as_parsed(&self) -> &[Fvk]

Returns the FVKs contained within this UFVK, in the order they were parsed from the string encoding.

This API is for advanced usage; in most cases you should use Ufvk::receivers.

type Item = Fvk

The type of item in this unified container.

fn items(&self) -> Vec<Self::Item>

Returns the items contained within this container, sorted in preference order.

impl Debug for Ufvk

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

Formats the value using the given formatter.

impl Encoding for Ufvk

fn try_from_items(items: Vec<Self::Item>) -> Result<Self, ParseError>

Constructs a value of a unified container type from a vector of container items, sorted according to typecode as specified in ZIP 316.

fn decode(s: &str) -> Result<(NetworkType, Self), ParseError>

Decodes a unified container from its string representation, preserving the order of its components so that it correctly obeys round-trip serialization invariants.

fn encode(&self, network: &NetworkType) -> String

Encodes the contents of the unified container to its string representation using the correct constants for the specified network, preserving the ordering of the contained items such that it correctly obeys round-trip serialization invariants.

impl Hash for Ufvk

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 Ufvk

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

impl StructuralPartialEq for Ufvk