Struct Secret 

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

A string secret that redacts itself in Debug output.

Wrapping a credential field in Secret makes a containing struct’s derived Debug print <redacted> for that field, so a future tracing::debug!("{creds:?}") or .context(format!("… {creds:?}")) cannot leak the value into logs or error chains.

Secret implements neither Display nor serde traits by design; the wrapped value is only reachable through expose_secret.

Examples

use omni_dev::utils::secret::Secret;

let token = Secret::new("s3cr3t");
assert_eq!(format!("{token:?}"), "<redacted>");
assert_eq!(token.expose_secret(), "s3cr3t");

Implementations

impl Secret

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

Creates a Secret wrapping the given value.

pub fn expose_secret(&self) -> &str

Returns the wrapped secret value.

The name is deliberately loud: every call site is an auditable point where the secret leaves the redacting wrapper.

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

Formats the value using the given formatter.

impl Eq for Secret

impl From<&str> for Secret

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for Secret

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for Secret

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