Struct BoundedLockedSecretString 

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

Locked UTF-8 text with a permanent type-level byte maximum.

Implementations

impl<const MAX: usize> BoundedLockedSecretString<MAX>

pub const fn max_len() -> usize

pub fn try_with_capacity_with_protection( capacity: usize, request: ProtectionRequest, ) -> Result<Self, ProtectedSecretTextFillError<Infallible>>

Construct empty bounded UTF-8 storage after required controls succeed.

pub fn try_from_capacity_with_protection<E>( capacity: usize, request: ProtectionRequest, fill: impl FnOnce(&mut [u8]) -> Result<usize, E>, ) -> Result<Self, ProtectedSecretTextFillError<E>>

Fill bounded locked UTF-8 storage after required controls succeed.

pub fn try_from_exact_len_with_protection<E>( len: usize, request: ProtectionRequest, fill: impl FnOnce(&mut [u8]) -> Result<(), E>, ) -> Result<Self, ProtectedSecretTextFillError<E>>

Fill an exact-length bounded locked UTF-8 value in place.

pub fn from_secret_str_with_protection( text: &str, request: ProtectionRequest, ) -> Result<Self, ProtectedSecretTextFillError<Infallible>>

Copy UTF-8 text after required controls are established.

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

pub const fn backing_capacity(&self) -> usize

pub const fn locked_len(&self) -> usize

pub const fn is_memory_locked(&self) -> bool

Returns true when the mapping is locked against ordinary paging.

pub const fn protection_report(&self) -> &ProtectionReport

pub const fn protection_request(&self) -> ProtectionRequest

pub fn try_with_secret<R>( &self, inspect: impl FnOnce(&str) -> R, ) -> Result<R, SecretTextIntegrityError>

pub fn try_with_secret_mut<R>( &mut self, edit: impl FnOnce(&mut str) -> R, ) -> Result<R, SecretTextIntegrityError>

pub fn try_push_str( &mut self, text: &str, ) -> Result<(), BoundedMappedSecretError<MemoryLockError>>

pub fn try_replace_from_secret_str( &mut self, text: &str, ) -> Result<(), BoundedMappedSecretError<MemoryLockError>>

pub fn clear_secret(&mut self)

pub fn try_constant_time_eq( &self, other: &str, ) -> Result<bool, CanaryCorruptedError>

pub fn verify_integrity(&self) -> Result<(), CanaryCorruptedError>

Trait Implementations

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

Available on non-WebAssembly 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 BoundedLockedSecretString<MAX>

Available on crate feature memory-lock and non-WebAssembly 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> ConstantTimeEq<str> for BoundedLockedSecretString<MAX>

Available on non-WebAssembly only.

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

Compare without secret-dependent early exit.

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

Negated ConstantTimeEq::ct_eq.

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

Available on crate feature memory-lock and (Android, or DragonFly BSD, or FreeBSD, or iOS, or macOS, or NetBSD, or OpenBSD, or Windows, or Linux and (AArch64 or x86-64)) only.

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

Formats the value using the given formatter.

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

Available on crate feature memory-lock and (Android, or DragonFly BSD, or FreeBSD, or iOS, or macOS, or NetBSD, or OpenBSD, or Windows, or Linux and (AArch64 or x86-64)) only.

fn secure_sanitize(&mut self)

Clear the sensitive bytes owned by this value.

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

Available on crate feature memory-lock and non-WebAssembly 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 BoundedLockedSecretString<MAX>

Available on crate feature memory-lock and non-WebAssembly only.