Struct SecretVec 

pub struct SecretVec { /* private fields */ }

Variable-size secret vector that wipes storage it owns

This type provides:

• Automatic zeroization on drop
• Secure cloning that preserves security properties
• Dynamic sizing with secure memory management

Implementations

impl SecretVec

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

Create a new secret vector with the given data.

The current allocation and its spare capacity become protected by this type. Allocations the caller freed before passing this Vec cannot be recovered or retroactively wiped.

pub fn from_slice(slice: &[u8]) -> SecretVec

Create a secret vector from a slice

pub fn empty() -> SecretVec

Create an empty secret vector

pub fn with_capacity(capacity: usize) -> SecretVec

Create a secret vector with the specified capacity

pub fn len(&self) -> usize

Get the length of the vector

pub fn is_empty(&self) -> bool

Check if the vector is empty

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

pub fn capacity(&self) -> usize

Get the allocation capacity.

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

Extend the vector with additional data

pub fn resize(&mut self, new_len: usize, value: u8)

Resize the vector to the specified length

pub fn truncate(&mut self, len: usize)

Truncate the vector to the specified length

pub fn clear(&mut self)

Remove all bytes while retaining a fully zeroed allocation.

pub fn push(&mut self, value: u8)

Append one byte, securely replacing the allocation when it is full.

pub fn pop(&mut self) -> Option<u8>

Remove and return the last byte, wiping its allocation slot first.

pub fn reserve(&mut self, additional: usize)

Reserve room for at least additional more bytes.

Unlike Vec::reserve, this never asks the allocator to resize the live secret allocation. It copies into a new allocation and wipes the old allocation before releasing it.

pub fn shrink_to_fit(&mut self)

Reduce capacity to the current length while wiping the old allocation.

Trait Implementations

impl AsMut<[u8]> for SecretVec

Available on crate feature alloc only.

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

Available on crate feature alloc only.

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

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

impl Clone for SecretVec

Available on crate feature alloc only.

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

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Drop for SecretVec

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 From<Vec<u8>> for SecretVec

Available on crate feature alloc only.

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

Converts to this type from the input type.

impl SecureZeroingType for SecretVec

Available on crate feature alloc only.

fn zeroed() -> SecretVec

Create a zeroed instance

fn secure_clone(&self) -> SecretVec

Create a secure clone that preserves security properties

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.