Struct WrapKey

pub struct WrapKey { /* private fields */ }

A wrapped Key for convenience and to ensure bytes are erased when dropped.

Implementations

impl WrapKey

pub fn key(&self) -> &Key

impl WrapKey

pub fn new(key: &Key) -> Self

Build a wrapped key by cloning the provided key. It is up to the caller to properly dispose of the memory.

pub fn from_bytes_and_erase_source(bytes: &mut [u8; 32]) -> Self

Convenience method. Build the key from the submitted array reference. Since the bytes are cloned, the source is zeroed to help prevent security breaches.

Trait Implementations

impl Clone for WrapKey

fn clone(&self) -> WrapKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WrapKey

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

Formats the value using the given formatter.

impl Drop for WrapKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<&GenericArray<u8, <Salsa<R20> as NewStreamCipher>::KeySize>> for WrapKey

fn from(key: &Key) -> Self

Converts to this type from the input type.

impl FromStr for WrapKey

Build a WrapKey from a base64 encoded string. Same precaution applies with the string data floating in memory after the key is built.

type Err = ParseKeyError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl PartialEq for WrapKey

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

impl StructuralPartialEq for WrapKey