Struct Zeroizing 

pub struct Zeroizing<T: Zeroize>(/* private fields */);

A wrapper that clears its initialized value when dropped.

Implementations

impl<T: Zeroize> Zeroizing<T>

pub const fn new(value: T) -> Self

pub fn into_inner(self) -> T

where T: Default,

Move the protected value out, leaving a zero/default value for Drop.

This is primarily useful at an ownership boundary where an exact-size boxed secret must become the caller’s output without creating a second secret allocation.

impl<const N: usize> Zeroizing<[u8; N]>

pub fn into_inner_array(self) -> [u8; N]

Move a protected byte array out while leaving an all-zero replacement.

This is the fixed-array counterpart to Self::into_inner for array lengths whose standard-library Default implementation is unavailable on the supported compiler baseline.

impl Zeroizing<Box<[u8]>>

pub fn as_slice(&self) -> &[u8]

Borrow the exact-size protected allocation as bytes.

pub fn as_mut_slice(&mut self) -> &mut [u8]

Mutably borrow the exact-size protected allocation as bytes.

pub fn capacity(&self) -> usize

Exact-size allocations have no inaccessible spare capacity.

Trait Implementations

impl<T: Zeroize> AsMut<T> for Zeroizing<T>

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

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

impl AsMut<[u8]> for Zeroizing<Box<[u8]>>

Available on crate features alloc or std only.

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

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

impl<T: Zeroize> AsRef<T> for Zeroizing<T>

fn as_ref(&self) -> &T

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

impl AsRef<[u8]> for Zeroizing<Box<[u8]>>

Available on crate features alloc or std only.

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

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

impl<T: Clone + Zeroize> Clone for Zeroizing<T>

fn clone(&self) -> Zeroizing<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Zeroize> Debug for Zeroizing<T>

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

Formats the value using the given formatter.

impl<T: Default + Zeroize> Default for Zeroizing<T>

fn default() -> Zeroizing<T>

Returns the “default value” for a type.

impl<T: Zeroize> Deref for Zeroizing<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Zeroize> DerefMut for Zeroizing<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: Zeroize> Drop for Zeroizing<T>

fn drop(&mut self)

Executes the destructor for this type.

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.

impl<T: Eq + Zeroize> Eq for Zeroizing<T>

impl<T: Ord + Zeroize> Ord for Zeroizing<T>

fn cmp(&self, other: &Zeroizing<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq + Zeroize> PartialEq for Zeroizing<T>

fn eq(&self, other: &Zeroizing<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd + Zeroize> PartialOrd for Zeroizing<T>

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: PartialEq + Zeroize> StructuralPartialEq for Zeroizing<T>

impl<T: Zeroize> Zeroize for Zeroizing<T>

fn zeroize(&mut self)

impl<T: Zeroize> ZeroizeOnDrop for Zeroizing<T>