Struct ExposedSecretString 

pub struct ExposedSecretString { /* private fields */ }

Owned secret UTF-8 text 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 string interop. Use Self::into_exposed_unprotected_string_caller_must_zeroize only when a raw String is unavoidable and the caller will handle cleanup.

Implementations

impl ExposedSecretString

pub fn from_string(text: String) -> Self

Wraps an owned UTF-8 string as exposed secret text.

pub fn len(&self) -> usize

Returns the length of the secret text in bytes.

pub fn is_empty(&self) -> bool

Returns whether the secret text is empty.

pub fn expose_secret(&self) -> &str

Reveals the secret text.

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

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

Reveals the secret text as bytes.

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

pub fn into_exposed_unprotected_string_caller_must_zeroize(self) -> String

Consumes the wrapper and returns a raw String.

This is an unprotected escape hatch. The returned string 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 AsRef<str> for ExposedSecretString

Available on crate feature alloc only.

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for ExposedSecretString

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Display for ExposedSecretString

Available on crate feature alloc only.

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

Formats the value using the given formatter.

impl Drop for ExposedSecretString

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.