Struct SecretString 

pub struct SecretString(/* private fields */);

Holds a credential and refuses to print it. Construct via SecretString::new(value) or String::into. Read with expose_secret() at the exact call site that needs the cleartext — those callers should be enumerable on git grep.

Implementations

impl SecretString

pub fn new(value: impl Into<String>) -> Self

Wrap a plaintext credential. The inner String is moved in and never reborrowed by reference outside this type.

pub fn expose_secret(&self) -> &str

Borrow the cleartext. Use sparingly — every call site is a place where the secret could leak into logs.

pub fn is_empty(&self) -> bool

True when the inner value is empty. Useful for “did the env var resolve?” checks without exposing the value.

pub fn len(&self) -> usize

Length of the inner value. Used by diagnostic logs to confirm “secret is present” without disclosing it.

Trait Implementations

impl Clone for SecretString

fn clone(&self) -> SecretString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretString

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

Formats the value using the given formatter.

impl Display for SecretString

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

Formats the value using the given formatter.

impl From<&str> for SecretString

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for SecretString

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for SecretString

fn eq(&self, other: &SecretString) -> 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 Serialize for SecretString

Serialize always emits the redaction marker so brain traces + MCP responses + run JSONL files cannot persist the cleartext.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SecretString

impl StructuralPartialEq for SecretString