veil 0.3.0

Rust derive macro for redacting sensitive data in `std::fmt::Debug`
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

use veil::redactor::{Redactor, RedactorBuilder};

fn main() {
    // Build a new Redactor.
    // We'll set up the Redactor to use flags that are equivalent to:
    // `#[redact(with = 'X', partial))]`
    // on a field, when using the `Redact` derive macro.
    let redactor: Redactor = RedactorBuilder::new().char('X').partial().build().unwrap();

    // We can now redact any string we want in a number of different ways...

    // Firstly, we can simply redact directly to a `String`:
    assert_eq!(redactor.redact("Hello, world!".to_string()), "HelXX, XXrld!");

    // Or, we can redact a `String` in-place, which is slightly more efficient,
    // and allows us to chain multiple redactions together:
    let mut hello = "Hello, world!".to_string();
    let mut goodbye = "Goodbye, world!".to_string();
    redactor.redact_in_place(&mut hello).redact_in_place(&mut goodbye);
    assert_eq!(hello, "HelXX, XXrld!");
    assert_eq!(goodbye, "GooXXXX, XXrld!");

    // Finally, we can use the `wrap` method to wrap a string in a `RedactWrapped` struct,
    // which implements `Debug` and `Display` to redact the string when displayed or debugged.
    let hello = "Hello, world!".to_string();
    let hello_wrapped = redactor.wrap(&hello);

    assert_ne!(hello_wrapped.to_string(), hello);
    assert_ne!(format!("{:?}", hello_wrapped), format!("{:?}", hello));

    assert_eq!(hello_wrapped.to_string(), "HelXX, XXrld!");
    assert_eq!(format!("{:?}", hello_wrapped), "\"HelXX, XXrld!\"");
}