Struct SecureBuffer 

pub struct SecureBuffer { /* private fields */ }

A page-guarded, mlock’d buffer for secret material.

Layout: [guard page (PROT_NONE)] [inner region, mlock’d] [guard page (PROT_NONE)]

Guard pages are filled with random canary bytes. On drop, canaries are verified (detects overflow), inner region is zeroized, and all pages are unmapped.

Implementations

impl SecureBuffer

pub fn new(size: usize) -> Result<Self>

Allocate a new mutable, mlock’d, guard-paged buffer.

pub fn size(&self) -> usize

pub fn is_alive(&self) -> bool

pub fn is_mutable(&self) -> bool

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

Get a mutable slice to the inner region. Requires Mutable state.

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

Get a read-only slice. Requires non-Dead state.

pub fn freeze(&mut self) -> Result<()>

Make the buffer read-only.

pub fn melt(&mut self) -> Result<()>

Make the buffer writable again.

pub fn destroy(&mut self) -> Result<()>

Verify guard-page canaries, zeroize, unlock, and free the allocation.

Idempotent — returns Ok(()) immediately if already Dead.

pub fn scramble(&mut self) -> Result<()>

Fill with random bytes (stays mutable).

Trait Implementations

impl Debug for SecureBuffer

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

Formats the value using the given formatter.

impl Drop for SecureBuffer

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 Send for SecureBuffer