Struct BoundedSecretVec 

pub struct BoundedSecretVec<const MAX: usize> { /* private fields */ }

Heap-allocated secret bytes constrained to a public maximum length.

This additive wrapper is intended for protocol and configuration trust boundaries where unbounded dynamic secret allocation is unacceptable. With the serde feature, every deserialization input form rejects more than MAX bytes. Rejected owned buffers and partially decoded values are cleared before they are released.

Implementations

impl<const MAX: usize> BoundedSecretVec<MAX>

pub const fn empty() -> Self

Create an empty bounded secret.

pub fn from_slice(bytes: &[u8]) -> Result<Self, SecretVecLimitError>

Copy a slice into bounded secret storage.

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

Take ownership of a vector after validating its length.

An oversized input allocation is volatile-cleared before the error is returned.

pub fn from_secret_vec(secret: SecretVec) -> Result<Self, SecretVecLimitError>

Convert an existing secret vector after validating its length.

An oversized input is cleared before the error is returned.

pub const fn max_len() -> usize

Maximum accepted length.

pub fn len(&self) -> usize

Number of initialized secret bytes.

pub fn is_empty(&self) -> bool

Returns true when no bytes are held.

pub fn with_secret<R>(&self, inspect: impl FnOnce(&[u8]) -> R) -> R

Run a closure with read-only access to the secret bytes.

pub fn with_secret_mut<R>(&mut self, edit: impl FnOnce(&mut [u8]) -> R) -> R

Run a closure with mutable access to the initialized secret bytes.

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

Append bytes without permitting the configured limit to be exceeded.

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

Replace the current value after validating the replacement length.

pub fn clear_secret(&mut self)

Clear this value immediately with volatile writes.

pub fn into_secret_vec(self) -> SecretVec

Return the bounded value as an ordinary clear-on-drop secret vector.

Trait Implementations

impl<const MAX: usize> ConstantTimeEq for BoundedSecretVec<MAX>

Available on crate feature alloc only.

fn ct_eq(&self, other: &Self) -> Choice

Compare without secret-dependent early exit.

fn ct_ne(&self, other: &Rhs) -> Choice

Negated ConstantTimeEq::ct_eq.

impl<const MAX: usize> ConstantTimeEq for BoundedSecretVec<MAX>

Available on crate feature alloc only.

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl<const MAX: usize> Debug for BoundedSecretVec<MAX>

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl<const MAX: usize> Default for BoundedSecretVec<MAX>

Available on crate feature alloc only.

fn default() -> Self

Returns the “default value” for a type.

impl<'de, const MAX: usize> Deserialize<'de> for BoundedSecretVec<MAX>

Available on crate feature alloc only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const MAX: usize> From<BoundedSecretVec<MAX>> for SecretVec

Available on crate feature alloc only.

fn from(secret: BoundedSecretVec<MAX>) -> Self

Converts to this type from the input type.

impl<const MAX: usize> SecureSanitize for BoundedSecretVec<MAX>

Available on crate feature alloc only.

fn secure_sanitize(&mut self)

Clear the sensitive bytes owned by this value.

impl<const MAX: usize> Serialize for BoundedSecretVec<MAX>

Available on crate feature alloc only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<const MAX: usize> Zeroize for BoundedSecretVec<MAX>

Available on crate feature alloc only.

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.

impl<const MAX: usize> ZeroizeOnDrop for BoundedSecretVec<MAX>

Available on crate feature alloc only.