Struct RedactedString 

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

A string newtype that hides its contents from Debug formatting.

Use for API secrets, passwords, and other credentials that must never appear in logs. Serializes/deserializes transparently as a plain string so the wire format is unchanged.

Call Self::expose_secret to access the underlying value when you genuinely need it (e.g. to authenticate a request).

Implementations

impl RedactedString

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

Wrap a string. Prefer From<String> / From<&str> in code.

pub fn expose_secret(&self) -> &str

Access the underlying secret. Use sparingly; never log the return value of this method.

Trait Implementations

impl Clone for RedactedString

fn clone(&self) -> RedactedString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactedString

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

Formats the value using the given formatter.

impl Default for RedactedString

fn default() -> RedactedString

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RedactedString

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RedactedString

impl From<&str> for RedactedString

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for RedactedString

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for RedactedString

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RedactedString