Struct Uivk

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

A Unified Incoming Viewing Key.

Examples

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

let example_uivk: &str = uivk_from_user();

let (network, uivk) = unified::Uivk::decode(example_uivk)?;

// We can obtain the pool-specific Incoming Viewing Keys for the UIVK in
// preference order (the order in which wallets should prefer to use their
// corresponding address receivers):
let ivks: Vec<unified::Ivk> = uivk.items();

// And we can create the UIVK from a list of IVKs:
let new_uivk = unified::Uivk::try_from_items(ivks)?;
assert_eq!(new_uivk, uivk);

Trait Implementations

impl Clone for Uivk

fn clone(&self) -> Uivk

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Container for Uivk

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

Returns the IVKs contained within this UIVK, in the order they were parsed from the string encoding.

This API is for advanced usage; in most cases you should use Uivk::items.

type Item = Ivk

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 Uivk

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

Formats the value using the given formatter.

impl Encoding for Uivk

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 Uivk

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 Uivk

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

impl StructuralPartialEq for Uivk