redactrs 0.1.4

Wrapper to avoid accidentally leaking sensitive data during printing/logging
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! Contains ready to use [Redactor]s
use crate::Redactor;
use std::fmt::Formatter;

/// [Redactor] that will redact the value to "\<redacted\>"
/// ```rust
/// # use redactrs::Redacted;
/// # use redactrs::redactors::Simple;
/// let redacted_value: Redacted<_, Simple> = "secret".into();
///
/// assert_eq!(redacted_value.to_string(), "<redacted>")
/// ```
pub struct Simple;
impl Redactor for Simple {
    fn redact(f: &mut Formatter) -> std::fmt::Result {
        write!(f, "<redacted>")
    }
}

/// Configurable [Redactor] that lets you specify the symbol and repetition."
/// ```rust
/// # use redactrs::Redacted;
/// # use redactrs::redactors::Custom;
/// let redacted_value: Redacted<_, Custom<'🤨', 3>> = "secret".into();
///
/// assert_eq!(redacted_value.to_string(), "🤨🤨🤨");
/// ```
///
/// The default values will result in a password style redaction: "●●●●●●●●"
/// ```rust
/// # use redactrs::Redacted;
/// # use redactrs::redactors::Custom;
/// let redacted_value: Redacted<_, Custom> = "secret".into();
///
/// assert_eq!(redacted_value.to_string(),"●●●●●●●●");
/// ```
pub struct Custom<const SYMBOL: char = '●', const REP: usize = 8>;
impl<const SYMBOL: char, const REP: usize> Redactor for Custom<SYMBOL, REP> {
    fn redact(f: &mut Formatter) -> std::fmt::Result {
        write!(
            f,
            "{}",
            std::iter::repeat(SYMBOL).take(REP).collect::<String>()
        )
    }
}