Struct Secured

#[repr(align(4096))]
pub struct Secured<T: Copy>(/* private fields */);

A stack-allocated value protected by locking its virtual memory page in physical memory.

Implementations

impl<T: Copy> Secured<T>

pub fn borrow_default<F, R>(&mut self, f: F) -> R

where F: FnOnce(SecureRef<&mut T>) -> R, T: Default,

For an existing Secured instance, fill with the default value of T and call the closure f with a mutable reference.

pub fn borrow_random<F, R>(&mut self, rng: impl RngCore, f: F) -> R

where F: FnOnce(SecureRef<&mut T>) -> R, T: FillBytes,

For an existing Secured instance, fill with a set of random bytes, then return the result of calling the closure f with a mutable reference.

pub fn borrow_take<F, R>(&mut self, take: &mut T, f: F) -> R

where F: FnOnce(SecureRef<&mut T>) -> R, T: DefaultIsZeroes,

For an existing Secured instance, fill with the default value of T and call the closure f with a mutable reference.

pub fn borrow_uninit<F, R>(&mut self, f: F) -> R

where F: FnOnce(SecureRef<&mut MaybeUninit<T>>) -> R,

For an existing Secured instance, call a closure f with a mutable reference to an uninitialized T.

pub fn default<F, R>(f: F) -> R

where F: FnOnce(SecureRef<&mut T>) -> R, T: Default,

Fill a Secured with the default value of T and return the result of calling the closure f with a mutable reference.

pub fn random<F, R>(rng: impl RngCore, f: F) -> R

where F: FnOnce(SecureRef<&mut T>) -> R, T: FillBytes,

Fill a Secured with a set of random bytes, then return the result of calling the closure f with a mutable reference.

pub fn take<F, R>(take: &mut T, f: F) -> R

where F: FnOnce(SecureRef<&mut T>) -> R, T: DefaultIsZeroes,

Fill a Secured by coping an existing value of type T, and zeroize the original copy. Return the result of calling the closure f with a mutable reference.

pub fn uninit<F, R>(f: F) -> R

where F: FnOnce(SecureRef<&mut MaybeUninit<T>>) -> R,

Call the closure f with a mutable reference to an uninitialized T.

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

pub fn borrow_bytes<F, R>(&mut self, f: F) -> R

where F: FnOnce(SecureRef<&mut [u8; N]>) -> R,

For an existing Secured instance, call a closure with a mutable reference to an array of bytes. The values of the bytes are initialized to a standard indicator value.

pub fn bytes<F, R>(f: F) -> R

where F: FnOnce(SecureRef<&mut [u8; N]>) -> R,

Call the closure f with a mutable reference to an array of bytes. The values of the bytes are initialized to a standard indicator value.

Trait Implementations

impl<T: Copy> ConstDefault for Secured<T>

const DEFAULT: Self

The constant default value.

impl<T: Copy> Debug for Secured<T>

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

Formats the value using the given formatter.

impl<T: Copy> Default for Secured<T>

fn default() -> Self

Returns the “default value” for a type.