Skip to main content

Key

Struct Key 

Source
pub struct Key { /* private fields */ }
Expand description

Base key type backed by exact-size secret storage.

Implementations§

Source§

impl Key

Source

pub fn new(data: &[u8]) -> Self

Copy key bytes directly into exact-size owned storage.

The caller retains responsibility for clearing the source buffer. This constructor intentionally accepts a slice rather than taking a Vec: safe Rust cannot inspect or erase a vector’s spare capacity.

Source

pub fn from_boxed_slice(data: Box<[u8]>) -> Self

Take ownership of an exact-size boxed key allocation.

Source

pub fn from_slice(data: &[u8]) -> Self

Copy key bytes directly into exact-size owned storage.

Source

pub fn new_zeros(len: usize) -> Self

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn to_bytes_zeroizing_boxed(&self) -> ZeroizingBytes

Serialize into exact-size storage that clears itself on drop.

Trait Implementations§

Source§

impl AsMut<[u8]> for Key

Source§

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.
Source§

impl AsRef<[u8]> for Key

Source§

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl Clone for Key

Source§

fn clone(&self) -> Key

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Drop for Key

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl From<Box<[u8]>> for Key

Source§

fn from(data: Box<[u8]>) -> Self

Converts to this type from the input type.
Source§

impl SerializeSecret for Key

Source§

fn from_bytes(bytes: &[u8]) -> Result<Self>

Creates an object from a byte slice. Input should be zeroized after use.
Source§

fn to_bytes_zeroizing(&self) -> ZeroizingBytes

Converts the object to exact-size bytes that are zeroized on drop.
Source§

impl Zeroize for Key

Source§

fn zeroize(&mut self)

Source§

impl ZeroizeOnDrop for Key

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnsafeUnpin for Key

§

impl UnwindSafe for Key

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.