Struct spirit::utils::Hidden

#[repr(transparent)]
pub struct Hidden<T>(pub T);

A wrapper to hide a configuration field from logs.

This acts in as much transparent way as possible towards the field inside. It only replaces the Debug and Serialize implementations with returning "******".

The idea is if the configuration contains passwords, they shouldn't leak into the logs. Therefore, wrap them in this, eg:

use std::io::Write;
use std::str;

use spirit::utils::Hidden;

#[derive(Debug)]
struct Cfg {
    username: String,
    password: Hidden<String>,
}

let cfg = Cfg {
    username: "me".to_owned(),
    password: "secret".to_owned().into(),
};

let mut buffer: Vec<u8> = Vec::new();
write!(&mut buffer, "{:?}", cfg)?;
assert_eq!(r#"Cfg { username: "me", password: "******" }"#, str::from_utf8(&buffer)?);

Trait Implementations

impl<T: PartialEq> PartialEq<Hidden<T>> for Hidden<T>

fn eq(&self, other: &Hidden<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Hidden<T>) -> bool

This method tests for !=.

impl<T: Default> Default for Hidden<T>

fn default() -> Hidden<T>

Returns the "default value" for a type.

impl<T: Ord> Ord for Hidden<T>

fn cmp(&self, other: &Hidden<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<T: Clone> Clone for Hidden<T>

fn clone(&self) -> Hidden<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> From<T> for Hidden<T>

fn from(val: T) -> Self

Performs the conversion.

impl<T: Eq> Eq for Hidden<T>

impl<T: PartialOrd> PartialOrd<Hidden<T>> for Hidden<T>

fn partial_cmp(&self, other: &Hidden<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Hidden<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Hidden<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Hidden<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Hidden<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> DerefMut for Hidden<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<T> Deref for Hidden<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Hash> Hash for Hidden<T>

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl<T> Debug for Hidden<T>

fn fmt(&self, fmt: &mut Formatter) -> FmtResult

Formats the value using the given formatter.

impl<T> Serialize for Hidden<T>

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

Serialize this value into the given Serde serializer.

impl<'de, T> Deserialize<'de> for Hidden<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> StructDoc for Hidden<T> where
    T: StructDoc, 

fn document() -> Documentation

Returns the documentation for the type.