Struct Secret 

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

A secret value — an API token, a password — that redacts itself whenever it is formatted, so it can’t leak into a log line or an error message. Read the underlying value only at the point of use, via expose.

Redaction is the achievable guarantee here; this type does not securely scrub its memory on drop.

Deliberately not PartialEq/Eq: comparing secrets with String’s short-circuiting == is timing-variable and turns the type into an equality oracle. Compare the exposed value explicitly if you must.

Implementations

impl Secret

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

Wrap a secret value.

pub fn expose(&self) -> &str

Borrow the underlying secret. Call this only where the value is actually needed (e.g. setting an environment variable on a command); don’t store or log the result.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.

impl Display for Secret

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

Formats the value using the given formatter.

impl From<&str> for Secret

fn from(value: &str) -> Secret

Converts to this type from the input type.

impl From<String> for Secret

fn from(value: String) -> Secret

Converts to this type from the input type.