Struct ViewKey 

pub struct ViewKey<N>(/* private fields */)
where
    N: Network;

The account view key used to decrypt records and ciphertext.

Implementations

impl<N> ViewKey<N>

where N: Network,

pub fn to_address(&self) -> Address<N>

Returns the address corresponding to the view key.

impl<N> ViewKey<N>

where N: Network,

pub const fn from_scalar(view_key: Scalar<N>) -> ViewKey<N>

Initializes the account view key from a scalar.

Methods from Deref<Target = Scalar<N>>

pub const SIZE_IN_BITS: usize = <E::Scalar>::SIZE_IN_BITS

pub const SIZE_IN_BYTES: usize

pub const SIZE_IN_DATA_BITS: usize = <E::Scalar>::SIZE_IN_DATA_BITS

Trait Implementations

impl<N> Clone for ViewKey<N>

where N: Clone + Network,

fn clone(&self) -> ViewKey<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for ViewKey<N>

where N: Debug + Network,

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

Formats the value using the given formatter.

impl<N> Deref for ViewKey<N>

where N: Network,

fn deref(&self) -> &<ViewKey<N> as Deref>::Target

Returns the account view key as a scalar.

type Target = Scalar<N>

The resulting type after dereferencing.

impl<'de, N> Deserialize<'de> for ViewKey<N>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<ViewKey<N>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes an account view key from a string or bytes.

impl<N> Display for ViewKey<N>

where N: Network,

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

Writes the account view key as a base58 string.

impl<N> FromBytes for ViewKey<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<ViewKey<N>, Error>

where R: Read,

Reads an account view key from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

fn from_bytes_le_unchecked(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Same behavior as Self::from_bytes_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_unchecked<R>(reader: R) -> Result<Self, Error>

where R: Read, Self: Sized,

Same behavior as Self::read_le but avoids costly checks. This shall only be called when deserializing from a trusted source, such as local storage.

fn read_le_with_unchecked<R>(reader: R, unchecked: bool) -> Result<Self, Error>

where R: Read, Self: Sized,

Helper function that deserializes either unchecked or checked based on the given boolean flag.

impl<N> FromStr for ViewKey<N>

where N: Network,

fn from_str(s: &str) -> Result<ViewKey<N>, <ViewKey<N> as FromStr>::Err>

Reads in an account view key from a base58 string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Hash for ViewKey<N>

where N: Hash + Network,

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

where __H: Hasher,

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<N> PartialEq for ViewKey<N>

where N: PartialEq + Network,

fn eq(&self, other: &ViewKey<N>) -> 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<N> Serialize for ViewKey<N>

where N: Network,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serializes an account view key into string or bytes.

impl<N> ToBytes for ViewKey<N>

where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes an account view key to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> TryFrom<&PrivateKey<N>> for ViewKey<N>

where N: Network,

Available on crate feature private_key only.

fn try_from( private_key: &PrivateKey<N>, ) -> Result<ViewKey<N>, <ViewKey<N> as TryFrom<&PrivateKey<N>>>::Error>

Initializes a new account view key from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<&ViewKey<N>> for Address<N>

where N: Network,

Available on crate feature view_key only.

fn try_from( view_key: &ViewKey<N>, ) -> Result<Address<N>, <Address<N> as TryFrom<&ViewKey<N>>>::Error>

Derives the account address from an account view key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<&ViewKey<N>> for GraphKey<N>

where N: Network,

Available on crate feature view_key only.

fn try_from( view_key: &ViewKey<N>, ) -> Result<GraphKey<N>, <GraphKey<N> as TryFrom<&ViewKey<N>>>::Error>

Derives the account graph key from an account view key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<(&PrivateKey<N>, &ComputeKey<N>)> for ViewKey<N>

where N: Network,

Available on crate feature private_key only.

fn try_from( _: (&PrivateKey<N>, &ComputeKey<N>), ) -> Result<ViewKey<N>, <ViewKey<N> as TryFrom<(&PrivateKey<N>, &ComputeKey<N>)>>::Error>

Initializes a new account view key from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<PrivateKey<N>> for ViewKey<N>

where N: Network,

Available on crate feature private_key only.

fn try_from( private_key: PrivateKey<N>, ) -> Result<ViewKey<N>, <ViewKey<N> as TryFrom<PrivateKey<N>>>::Error>

Initializes a new account view key from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<ViewKey<N>> for Address<N>

where N: Network,

Available on crate feature view_key only.

fn try_from( view_key: ViewKey<N>, ) -> Result<Address<N>, <Address<N> as TryFrom<ViewKey<N>>>::Error>

Derives the account address from an account view key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<ViewKey<N>> for GraphKey<N>

where N: Network,

Available on crate feature view_key only.

fn try_from( view_key: ViewKey<N>, ) -> Result<GraphKey<N>, <GraphKey<N> as TryFrom<ViewKey<N>>>::Error>

Derives the account graph key from an account view key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> Zeroize for ViewKey<N>

where N: Network,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<N> Copy for ViewKey<N>

where N: Copy + Network,

impl<N> Eq for ViewKey<N>

where N: Eq + Network,

impl<N> StructuralPartialEq for ViewKey<N>

where N: Network,