Struct SecretBuffer

pub struct SecretBuffer<const N: usize> { /* private fields */ }

Fixed-size secret buffer that guarantees zeroization

This type provides:

• Automatic zeroization on drop
• Secure cloning that preserves security properties
• Type-safe size guarantees at compile time

Implementations

impl<const N: usize> SecretBuffer<N>

pub fn new(data: [u8; N]) -> SecretBuffer<N>

Create a new secret buffer with the given data

pub fn zeroed() -> SecretBuffer<N>

Create a zeroed secret buffer

pub fn len(&self) -> usize

Get the length of the buffer

pub fn is_empty(&self) -> bool

Check if the buffer is empty (always false for non-zero N)

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

Get a reference to the inner data

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

Get a mutable reference to the inner data

Trait Implementations

impl<const N: usize> AsMut<[u8]> for SecretBuffer<N>

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

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

impl<const N: usize> AsRef<[u8]> for SecretBuffer<N>

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

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

impl<const N: usize> Clone for SecretBuffer<N>

fn clone(&self) -> SecretBuffer<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for SecretBuffer<N>

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

Formats the value using the given formatter.

impl<const N: usize> Drop for SecretBuffer<N>

fn drop(&mut self)

Executes the destructor for this type.

impl<const N: usize> SecureZeroingType for SecretBuffer<N>

fn zeroed() -> SecretBuffer<N>

Create a zeroed instance

fn secure_clone(&self) -> SecretBuffer<N>

Create a secure clone that preserves security properties

impl<const N: usize> Zeroize for SecretBuffer<N>

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.