Struct Redacted 

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

A string value that prints <redacted> in Debug and Display output.

Use expose to access the inner value when you genuinely need it (e.g. for sending over the wire). The Debug and Display implementations are generated by the derive_more crate.

Examples

use openvpn_mgmt_codec::Redacted;

let secret = Redacted::new("hunter2");
assert_eq!(format!("{secret:?}"), "<redacted>");
assert_eq!(format!("{secret}"), "<redacted>");
assert_eq!(secret.expose(), "hunter2");

Implementations

impl Redacted

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

Wrap a string as redacted.

pub fn expose(&self) -> &str

Access the inner value.

Use this when you genuinely need the raw string, for instance when encoding it onto the wire. Avoid passing the result to logging or display formatting.

pub fn into_inner(self) -> String

Consume the wrapper and return the inner string.

Trait Implementations

impl Clone for Redacted

fn clone(&self) -> Redacted

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Redacted

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

Formats the value using the given formatter.

impl Display for Redacted

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

Formats the value using the given formatter.

impl From<&str> for Redacted

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for Redacted

fn from(s: String) -> Self

Converts to this type from the input type.

impl PartialEq for Redacted

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

impl StructuralPartialEq for Redacted