Struct LockedBox

pub struct LockedBox<T>(/* private fields */);

A [Box]-like type that uses mlock to prevent paging the allocated memory to disk.

Note: This type allocates in multiples of the operating system’s page size. This could lead to more memory usage than expected if many instances of this type are used.

Implementations

impl<T> LockedBox<T>

pub fn new(contained: T) -> Self

Creates a new locked box with contained in a newly allocated, mlock-protected region of memory.

Panics

This function panics if size_of::<T>() >= usize::MAX - 4 * PAGE_SIZE or the underlying allocation fails.

pub fn try_new(contained: T) -> Option<Self>

Creates a new locked box with contained in a newly allocated, mlock-protected region of memory.

Returns None if size_of::<T>() >= usize::MAX - 4 * PAGE_SIZE or the underlying allocation fails.

pub const fn ptr(boxed: &LockedBox<T>) -> *mut T

Returns the pointer to the underlying data.

pub fn unbox(boxed: LockedBox<T>) -> T

Extracts the contained value from boxed.

Trait Implementations

impl<T> Deref for LockedBox<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for LockedBox<T>

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

Mutably dereferences the value.

impl<T> Drop for LockedBox<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Send for LockedBox<T>

where T: Send,

impl<T> Sync for LockedBox<T>

where T: Sync,

impl<T> UnwindSafe for LockedBox<T>

where T: UnwindSafe,