Struct Secret 

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

A credential or other value that must not reach a log.

Its Debug prints Secret([REDACTED]) whatever it holds, and it has no Display, so a struct that derives Debug can carry one safely. Read the value with expose, at the one place that needs it.

use polyoxide_venue::Secret;

let key = Secret::new(String::from("hunter2"));
assert_eq!(format!("{key:?}"), "Secret([REDACTED])");
assert_eq!(key.expose(), "hunter2");

Implementations

impl<T> Secret<T>

pub const fn new(value: T) -> Self

Wraps a value.

pub fn expose(&self) -> &T

The value. Every read goes through here, so each one is easy to find.

Trait Implementations

impl<T: Clone> Clone for Secret<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 Secret<T>

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

Formats the value using the given formatter.