Struct SecretVec 

pub struct SecretVec { /* private fields */ }

Variable-length byte sequence stored in guarded, zeroizing memory.

Secret bytes are deliberately unavailable through Deref or indexing. Use a callback-scoped read method and avoid retaining ordinary-memory copies.

Implementations

impl SecureVec

pub fn new() -> SecureVec

Creates an empty secure vector without allocating secret pages.

pub fn try_from_vec(bytes: Vec<u8>) -> Result<SecureVec, Error>

Moves bytes into secure memory and zeroizes the input vector.

pub fn try_from_slice(bytes: &[u8]) -> Result<SecureVec, Error>

Copies a byte slice into secure memory.

pub fn try_clone(&self) -> Result<SecureVec, Error>

Creates an independent secure copy without exposing plaintext bytes.

pub fn with_bytes<R>(&self, f: impl FnOnce(&[u8]) -> R) -> Result<R, Error>

Exposes the bytes only for the duration of f.

pub fn with_bytes_in<R>( &self, access: &SecureReadAccess<'_>, f: impl FnOnce(&[u8]) -> R, ) -> Result<R, Error>

Exposes bytes using an existing secure read scope.

pub fn try_push(&mut self, byte: u8) -> Result<(), Error>

Appends one byte, growing the secure allocation when required.

pub fn try_extend_from_slice(&mut self, bytes: &[u8]) -> Result<(), Error>

Appends ordinary bytes to this secure allocation.

pub fn try_extend_from_secure( &mut self, source: &SecureVec, ) -> Result<(), Error>

Appends all bytes from another secure vector without normal-heap copies.

pub fn try_extend_secure_range( &mut self, source: &SecureVec, offset: usize, len: usize, ) -> Result<(), Error>

Appends a validated range from another secure vector.

Returns Error::CapacityOverflow if the range is outside source.

pub fn try_clone_range( &self, offset: usize, len: usize, ) -> Result<SecureVec, Error>

Creates a secure copy of a validated byte range.

pub fn resize_zeroed(&mut self, len: usize) -> Result<(), Error>

Changes the logical length, zero-filling growth and wiping truncation.

pub fn truncate(&mut self, len: usize) -> Result<(), Error>

Shortens the vector and wipes the removed range.

pub fn with_mut_bytes<R>( &mut self, f: impl FnOnce(&mut [u8]) -> R, ) -> Result<R, Error>

Grants mutable access for the duration of f and restores protection.

Mutation fails with Error::ReadAccessActive during any read scope.

pub fn try_pop(&mut self) -> Result<Option<u8>, Error>

Removes and wipes the final byte, returning None when empty.

pub fn len(&self) -> usize

Returns the number of initialized secret bytes.

pub fn is_empty(&self) -> bool

Returns true when no secret bytes are initialized.

pub fn zeroize(&mut self) -> Result<(), Error>

Wipes the full backing allocation and resets the logical length.

Trait Implementations

impl Debug for SecureVec

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

Formats the value using the given formatter.

impl Default for SecureVec

fn default() -> SecureVec

Returns the “default value” for a type.

impl Drop for SecureVec

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 Eq for SecureVec

impl PartialEq for SecureVec

fn eq(&self, other: &SecureVec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl TryFrom<&[u8]> for SecureVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<SecureVec, Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for SecureVec

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: Vec<u8>) -> Result<SecureVec, Error>

Performs the conversion.