Struct SecretVec 

pub struct SecretVec(/* private fields */);

A vector that zeroizes its contents on drop.

Use this type for storing sensitive data like keys, passwords, or plaintext that should not remain in memory after use.

Example

use crabgraph::secrets::SecretVec;

let mut secret = SecretVec::new(vec![1, 2, 3, 4]);
// Use secret...
drop(secret); // Memory is automatically zeroized

Implementations

impl SecretVec

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

Creates a new SecretVec from a byte vector.

Example

use crabgraph::secrets::SecretVec;

let secret = SecretVec::new(vec![1, 2, 3]);

pub fn with_capacity(capacity: usize) -> Self

Creates a new SecretVec with the specified capacity.

Example

use crabgraph::secrets::SecretVec;

let mut secret = SecretVec::with_capacity(32);

pub fn zero(len: usize) -> Self

Creates a new SecretVec filled with zeros.

Example

use crabgraph::secrets::SecretVec;

let secret = SecretVec::zero(32);
assert_eq!(secret.len(), 32);

pub fn len(&self) -> usize

Returns the length of the secret data.

pub fn is_empty(&self) -> bool

Returns true if the secret is empty.

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

Returns a reference to the secret data.

Security Note

Be careful not to copy or clone the returned slice, as that would create unprotected copies in memory.

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

Returns a mutable reference to the secret data.

Security Note

Any modifications should be careful not to leak the old data.

pub fn into_inner(self) -> Vec<u8>

Consumes the SecretVec and returns the inner Vec<u8>.

Security Warning

The returned Vec<u8> is NOT automatically zeroized. Use this only when you need to pass ownership to another zeroizing container.

pub fn extend_from_slice(&mut self, data: &[u8])

Extends the secret with additional data.

Trait Implementations

impl AsMut<[u8]> for SecretVec

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

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

impl AsRef<[u8]> for SecretVec

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

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

impl Clone for SecretVec

fn clone(&self) -> SecretVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretVec

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

Formats the value using the given formatter.

impl Drop for SecretVec

fn drop(&mut self)

Executes the destructor for this type.

impl From<Vec<u8>> for SecretVec

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl Zeroize for SecretVec

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.