Struct GuardedMemory 

pub struct GuardedMemory { /* private fields */ }

A guarded memory region that zeroizes on drop.

For enclave environments where sensitive data must be:

1. Zeroized when no longer needed
2. Tracked for lifetime management
3. Protected from accidental copies
4. Locked in RAM (when mlock feature is enabled)

Uses Box<[u8]> internally (not Vec<u8>) to guarantee the backing pointer is never invalidated by reallocation — critical for mlock safety.

Example

use chains_sdk::security::GuardedMemory;

let mut guard = GuardedMemory::new(32);
guard.as_mut()[..4].copy_from_slice(&[0xDE, 0xAD, 0xBE, 0xEF]);
// memory is automatically zeroized (and munlocked) when `guard` is dropped

Implementations

impl GuardedMemory

pub fn new(size: usize) -> Self

Allocate a new guarded memory region of size bytes (zeroed).

When the mlock feature is enabled, the memory is locked into RAM to prevent the OS from swapping it to disk.

pub fn from_vec(data: Vec<u8>) -> Self

Create from existing data (takes ownership, original is NOT zeroized).

Prefer this over copying into a new() buffer when you already have the data in a Vec<u8>.

impl GuardedMemory

pub fn len(&self) -> usize

Length of the guarded region in bytes.

pub fn is_empty(&self) -> bool

Whether the guarded region is empty.

Trait Implementations

impl AsMut<[u8]> for GuardedMemory

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

Mutable access to the guarded bytes.

impl AsRef<[u8]> for GuardedMemory

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

Immutable access to the guarded bytes.

impl Debug for GuardedMemory

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

Formats the value using the given formatter.

impl Drop for GuardedMemory

fn drop(&mut self)

Executes the destructor for this type.