Struct SecretString 

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

A string value that should not appear in logs, Debug output, or serialized JSON.

• Debug prints [REDACTED] (or "" if empty)
• Serialize emits an empty string (never the actual value)
• Deserialize accepts a plain string (backward compatible with old configs)
• Display prints [REDACTED] (or empty if the value is empty)
• expose() returns the inner value for actual use

Implementations

impl SecretString

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

Create a new SecretString wrapping the given value.

pub fn expose(&self) -> &str

Get the actual secret value. Use sparingly and only where needed (e.g., HTTP Authorization headers, API calls).

pub fn is_empty(&self) -> bool

Returns true if the wrapped value is empty.

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 Default for SecretString

fn default() -> SecretString

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecretString

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

Deserialize this value from the given Serde deserializer.

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(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for SecretString

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for SecretString

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

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

Serialize this value into the given Serde serializer.