redacted 0.2.0-alpha.3

Wrappers to control debug formatting of potentially sensitive byte arrays
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

# Redacted

Library providing a transparent wrapper type for controlling [`Debug`] and [`Display`] behavior for
potentially sensitive collections of bytes, including completely redacting them.

This library is intended to aid in controlling how sensitive types, such as cryptographic types,
appear in logs, including being able to redact them entirely to prevent leaking sensitive
information through debug output. However, it is more generally useful, and can also be used simply
to force byte arrays to render as hex or the like in debug output.

## Examples

### Completely redact contents

``` rust
use redacted::FullyRedacted;

let item = FullyRedacted::new(vec![0_u8; 32]);
let output = format!("{:?}", item);

assert_eq!(output, "[32 BYTES REDACTED]");
```

### Render contents as hex

``` rust
use redacted::{Redacted, formatter::FullHex};

let item: Redacted<_, FullHex> = Redacted::new(vec![0_u8; 8]);
let output = format!("{:?}", item);

assert_eq!(output, "0x0000000000000000");
```

### Render contents as a truncated hex string

``` rust
use redacted::{Redacted, formatter::TruncHex};

let item: Redacted<_, TruncHex<8>> = Redacted::new(vec![0_u8; 32]);
let output = format!("{:?}", item);

assert_eq!(output, "0x00000000...(32 bytes)");
```