Struct SecretBuffer 

pub struct SecretBuffer { /* private fields */ }

Owned sensitive bytes with redacted formatting and drop-time cleanup.

SecretBuffer is available with the alloc feature. It is intended for decoded keys, tokens, and other values that should not be accidentally logged. The buffer exposes contents only through explicit reveal methods.

On drop, initialized bytes are cleared with the crate’s internal best-effort wipe helper. This is data-retention reduction, not a formal zeroization guarantee, and it cannot make claims about allocator spare capacity or historical copies outside the wrapper.

Implementations

impl SecretBuffer

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

Wraps an existing vector as sensitive material.

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

Copies a slice into an owned sensitive buffer.

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 clear(&mut self)

Clears the initialized bytes and makes the buffer empty.

Trait Implementations

impl Clone for SecretBuffer

Available on crate feature alloc only.

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretBuffer

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Display for SecretBuffer

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Drop for SecretBuffer

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.

impl PartialEq for SecretBuffer

Available on crate feature alloc only.

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SecretBuffer

Available on crate feature alloc only.