Struct SecretVec 

pub struct SecretVec { /* private fields */ }

Owned heap secret bytes with initialized and spare-capacity cleanup.

Implementations

impl SecretVec

pub fn from_vec(bytes: Vec<u8>) -> Self

Takes ownership and wipes the vector’s spare capacity.

pub fn from_slice(bytes: &[u8]) -> Self

Copies caller-owned bytes into secret storage.

pub fn replace_from_vec(&mut self, replacement: Vec<u8>)

Replaces the owned bytes after wiping the displaced allocation.

The replacement’s spare capacity is wiped before ownership transfers. The previous initialized bytes and spare capacity are wiped before its allocation is released. This remains best-effort software cleanup and cannot remove historical copies or allocator metadata.

pub fn expose_secret(&self) -> ExposedSecret<'_>

Creates an explicit borrowed interoperability view.

pub fn expose_secret_mut(&mut self) -> ExposedSecretMut<'_>

Creates an explicit mutable interoperability view.

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

Deliberately returns an ordinary vector without crate-managed cleanup.

pub fn len(&self) -> usize

Returns the public initialized length.

pub fn is_empty(&self) -> bool

Returns whether the initialized prefix is empty.

pub fn capacity(&self) -> usize

Returns the public allocation capacity.

pub fn clear(&mut self)

Wipes initialized bytes and spare capacity, then resets the length.

Trait Implementations

impl Debug for SecretVec

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

Formats the value using the given formatter.

impl Display for SecretVec

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

Formats the value using the given formatter.

impl Drop for SecretVec

Available on crate feature alloc only.

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.