Struct ExposedSecretVec 

pub struct ExposedSecretVec { /* private fields */ }

Owned secret bytes extracted from SecretBuffer.

This wrapper keeps redacted formatting, best-effort spare-capacity clearing at construction time, and best-effort full wipe on drop after a SecretBuffer is consumed for owned interop. Use Self::into_exposed_unprotected_vec_caller_must_zeroize only when a raw Vec<u8> is unavoidable and the caller will handle cleanup.

Implementations

impl ExposedSecretVec

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

Wraps an owned vector as exposed secret material.

pub fn len(&self) -> usize

Returns the number of initialized secret bytes.

pub fn is_empty(&self) -> bool

Returns whether the buffer contains no initialized secret bytes.

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

Reveals the secret bytes.

This method is intentionally named to make secret access explicit at the call site.

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

Reveals the secret bytes mutably.

This method is intentionally named to make secret access explicit at the call site.

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

Consumes the wrapper and returns a raw Vec<u8>.

This is an unprotected escape hatch. The returned vector is no longer redacted by formatting and will not be cleared by this crate on drop. Callers must clear it with their own approved zeroization policy.

Trait Implementations

impl AsMut<[u8]> for ExposedSecretVec

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 ExposedSecretVec

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 Debug for ExposedSecretVec

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Display for ExposedSecretVec

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Drop for ExposedSecretVec

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.