Struct Zeroizing 

pub struct Zeroizing<Z: Zeroize + ?Sized>(/* private fields */);

Zeroizing is a wrapper for any Z: Zeroize type which implements a Drop handler which zeroizes dropped values.

Zeroizing<T> is defined with repr(transparent), which means it is guaranteed to have the same physical representation as the underlying type.

Implementations

impl<Z> Zeroizing<Z>

where Z: Zeroize,

pub fn new(value: Z) -> Self

Move value inside a Zeroizing wrapper which ensures it will be zeroized when it’s dropped.

Trait Implementations

impl<T, Z> AsMut<T> for Zeroizing<Z>

where T: ?Sized, Z: AsMut<T> + Zeroize + ?Sized,

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

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

impl<T, Z> AsRef<T> for Zeroizing<Z>

where T: ?Sized, Z: AsRef<T> + Zeroize + ?Sized,

fn as_ref(&self) -> &T

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

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Z: Debug + Zeroize + ?Sized> Debug for Zeroizing<Z>

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

Formats the value using the given formatter.

impl<Z: Default + Zeroize + ?Sized> Default for Zeroizing<Z>

fn default() -> Zeroizing<Z>

Returns the “default value” for a type.

impl<Z> Deref for Zeroizing<Z>

where Z: Zeroize + ?Sized,

type Target = Z

The resulting type after dereferencing.

fn deref(&self) -> &Z

Dereferences the value.

impl<Z> DerefMut for Zeroizing<Z>

where Z: Zeroize + ?Sized,

fn deref_mut(&mut self) -> &mut Z

Mutably dereferences the value.

impl<'de, Z> Deserialize<'de> for Zeroizing<Z>

where Z: Zeroize + Deserialize<'de>,

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Z> Drop for Zeroizing<Z>

where Z: Zeroize + ?Sized,

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<Z: Eq + Zeroize + ?Sized> Eq for Zeroizing<Z>

impl<Z> From<Z> for Zeroizing<Z>

where Z: Zeroize,

fn from(value: Z) -> Zeroizing<Z>

Converts to this type from the input type.

impl<Z: PartialEq + Zeroize + ?Sized> PartialEq for Zeroizing<Z>

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

where Z: Zeroize + Serialize + ?Sized,

Available on crate feature serde only.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<Z: Zeroize + ?Sized> StructuralPartialEq for Zeroizing<Z>

impl<Z> Zeroize for Zeroizing<Z>

where Z: Zeroize + ?Sized,

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<Z> ZeroizeOnDrop for Zeroizing<Z>

where Z: Zeroize + ?Sized,