Struct ConfigSecret 

pub struct ConfigSecret<T>(/* private fields */);

A wrapper type for sensitive configuration values that should never be printed.

IMPORTANT: This type is only designed for configuration secrets and should not be used for other purposes. It does not provide protection against memory inspection, it does not zeroize the memory on drop, and may be sensible to time-based attacks.

This type implements Debug and Display to always show [REDACTED] instead of the actual value, preventing accidental exposure in logs or console output.

Note on Serialization: When serialized, this type always outputs "[REDACTED]" regardless of the inner value. Deserialization works normally, parsing the actual value. This asymmetry is intentional to prevent accidental secret exposure in serialized output.

Implementations

impl<T> ConfigSecret<T>

pub fn new(value: T) -> Self

Creates a new secret configuration value.

pub fn expose_secret(&self) -> &T

Exposes the inner secret value.

Use this method carefully and only when you actually need the secret value.

pub fn into_inner(self) -> T

Consumes the wrapper and returns the inner secret value.

Trait Implementations

impl<T: Clone> Clone for ConfigSecret<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ConfigSecret<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for ConfigSecret<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for ConfigSecret<T>

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for ConfigSecret<T>

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

Formats the value using the given formatter.

impl<T> From<T> for ConfigSecret<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: FromStr> FromStr for ConfigSecret<T>

type Err = <T as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: Hash> Hash for ConfigSecret<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for ConfigSecret<T>

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<T: Serialize> Serialize for ConfigSecret<T>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for ConfigSecret<T>