Struct engine::vault::Key

pub struct Key<T: BoxProvider> {
    pub key: GuardedVec<u8>,
    // some fields omitted
}

A key to the crypto box. Key is stored on the heap which makes it easier to erase.

Fields

key: GuardedVec<u8>

the guarded raw bytes that make up the key

Implementations

impl<T: BoxProvider> Key<T>

pub fn random() -> Result<Self>

generate a random key using secure random bytes

pub fn load(key: Vec<u8>) -> Result<Self>

attempts to load a key from inputted data

pub fn bytes(&self) -> Vec<u8>

get the key’s bytes

Trait Implementations

impl<T: BoxProvider> Clone for Key<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: BoxProvider> Debug for Key<T>

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

Formats the value using the given formatter.

impl<'de, T: BoxProvider> Deserialize<'de> for Key<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: BoxProvider> Eq for Key<T>

impl<T: BoxProvider> Hash for Key<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<T: BoxProvider> Ord for Key<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: BoxProvider> PartialEq<Key<T>> for Key<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: BoxProvider> PartialOrd<Key<T>> for Key<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: BoxProvider> Serialize for Key<T>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.