Struct SecretString 

pub struct SecretString { /* private fields */ }

UTF-8 secret stored in guarded, zeroizing memory.

The value intentionally implements neither Display nor direct string access. Use SecureString::with_str or SecureString::with_bytes and do not retain copies beyond the callback.

Implementations

impl SecureString

pub fn new() -> SecureString

Creates an empty secure string without allocating secret pages.

pub fn try_from_bytes(bytes: Vec<u8>) -> Result<SecureString, Error>

Moves bytes into secure memory and zeroizes the input vector.

UTF-8 is validated when text access is requested. Prefer SecureString::try_from_utf8 when invalid input should fail eagerly.

pub fn try_from_slice(bytes: &[u8]) -> Result<SecureString, Error>

Copies bytes into a new secure string.

pub fn from_secure_vec(bytes: SecureVec) -> SecureString

Wraps an existing secure byte vector without copying it.

pub fn try_from_utf8(bytes: Vec<u8>) -> Result<SecureString, Error>

Validates UTF-8, moves the bytes into secure memory, and zeroizes input.

pub fn try_from_env(name: &str) -> Result<Option<SecureString>, Error>

Reads an environment variable directly into a secure string when set.

pub fn try_from_os_string(value: OsString) -> Result<SecureString, Error>

Converts an operating-system string into a secure UTF-8 representation.

pub fn try_clone(&self) -> Result<SecureString, Error>

Creates an independent secure copy of this string.

pub fn with_str<R>(&self, f: impl FnOnce(&str) -> R) -> Result<R, Error>

Exposes valid UTF-8 text only for the duration of f.

pub fn with_str_in<R>( &self, access: &SecureReadAccess<'_>, f: impl FnOnce(&str) -> R, ) -> Result<R, Error>

Exposes valid UTF-8 text using an existing secure read scope.

pub fn with_bytes<R>(&self, f: impl FnOnce(&[u8]) -> R) -> Result<R, Error>

Exposes the encoded bytes only for the duration of f.

pub fn with_bytes_in<R>( &self, access: &SecureReadAccess<'_>, f: impl FnOnce(&[u8]) -> R, ) -> Result<R, Error>

Exposes encoded bytes using an existing secure read scope.

pub fn append_to_secure_vec(&self, target: &mut SecureVec) -> Result<(), Error>

Appends this value to target without copying through normal heap memory.

pub fn try_push_byte(&mut self, byte: u8) -> Result<(), Error>

Appends one byte to the secure string.

This low-level operation does not validate that the resulting value is UTF-8; subsequent text access will fail if the sequence is invalid.

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

Appends bytes without intermediate normal-memory allocation.

pub fn try_push_utf8_char(&mut self, ch: char) -> Result<(), Error>

Encodes and appends one Unicode scalar value.

pub fn try_pop_byte(&mut self) -> Result<Option<u8>, Error>

Removes, zeroes, and returns the final encoded byte, if present.

pub fn is_empty(&self) -> bool

Returns true when the string contains no bytes.

pub fn zeroize(&mut self) -> Result<(), Error>

Overwrites the allocation and resets the string to empty.

Trait Implementations

impl Debug for SecureString

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

Formats the value using the given formatter.

impl Default for SecureString

fn default() -> SecureString

Returns the “default value” for a type.

impl Eq for SecureString

impl PartialEq for SecureString

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

Equality operator ==.

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

Inequality operator !=.