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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

use std::fmt;

/// Errors returned while building a [`Redactor`](crate::Redactor) or redacting input.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// A format name was requested that no registered [`Format`](crate::format::Format) provides.
    #[error("unknown format {0:?}")]
    UnknownFormat(String),

    /// A user-supplied pattern failed to compile.
    #[error("invalid pattern for {name:?}: {message}")]
    InvalidPattern {
        /// The detector or setting that owns the pattern.
        name: String,
        /// The sanitized compilation error.
        message: String,
    },

    /// A ruleset file could not be loaded.
    #[error("ruleset: {0}")]
    Ruleset(String),

    /// A configuration file could not be read or understood.
    #[error("config: {0}")]
    Config(String),

    /// A detector failed while looking at the input, so the input cannot be
    /// said to be clean.
    #[error("{name}: {message}")]
    Detector {
        /// The detector that failed.
        name: String,
        /// The detector's error message.
        message: String,
    },

    /// The input could not be processed as the requested format.
    #[error(transparent)]
    Format(#[from] FormatError),

    /// Reading or writing bytes failed.
    #[error(transparent)]
    Io(#[from] std::io::Error),
}

/// A format failed to parse or re-serialize its input.
#[derive(Debug, thiserror::Error)]
#[error("{format}: {message}")]
pub struct FormatError {
    format: String,
    message: String,
}

impl FormatError {
    /// Create an error for `format` from a displayable message.
    pub fn new(format: impl Into<String>, message: impl fmt::Display) -> Self {
        Self {
            format: format.into(),
            message: message.to_string(),
        }
    }

    /// Name of the format that failed.
    pub fn format(&self) -> &str {
        &self.format
    }

    /// The parser or serializer error message.
    pub fn message(&self) -> &str {
        &self.message
    }
}