velociredactor 0.1.1

Redact secrets and PII from text and structured files, with stable numbered redactions
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

use super::{Format, FormatError, Leaf, LeafVisitor, Splicer};

/// Plain text. The whole input is one value.
///
/// Bytes that are not valid UTF-8 are passed through untouched; each valid
/// UTF-8 run between them is scanned as a separate value.
#[derive(Debug, Clone, Copy, Default)]
pub struct Text;

impl Text {
    /// The format name used by registries and format hints.
    pub const NAME: &'static str = "text";
}

impl Format for Text {
    fn name(&self) -> &str {
        Self::NAME
    }

    fn extensions(&self) -> &[&str] {
        &["txt", "log", "md", "text"]
    }

    fn rewrite(&self, input: &[u8], visitor: &mut dyn LeafVisitor) -> Result<Vec<u8>, FormatError> {
        let mut splicer = Splicer::new(input);
        let mut offset = 0;
        for chunk in input.utf8_chunks() {
            let valid = chunk.valid();
            if !valid.is_empty() {
                let leaf = Leaf::new(valid).with_offset(offset);
                if let Some(replacement) = visitor.leaf(&leaf) {
                    let range = offset..offset + valid.len();
                    splicer.apply(range.clone(), range, valid, &replacement, |v| v.to_owned());
                }
            }
            offset += valid.len() + chunk.invalid().len();
        }
        Ok(splicer.finish())
    }
}