Struct RulesFile 

#[non_exhaustive]
pub struct RulesFile {
    pub version: u32,
    pub detectors: Detectors,
    pub dictionary: Vec<DictionaryEntry>,
    pub regex: Vec<RegexRule>,
    pub allowlist: Vec<String>,
}

What gets redacted. Serialised as rules.yaml.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: u32

The format version. Only 1 exists.

detectors: Detectors

Which built-in detectors run, and their options.

dictionary: Vec<DictionaryEntry>

Fixed terms to redact, such as client or project names.

regex: Vec<RegexRule>

Patterns to redact, each with its own kind.

allowlist: Vec<String>

Values that are never redacted. An entry with @ and no local part (@acme.com) or a bare domain (acme.com) allows every email address and URL at that domain and its subdomains.

Trait Implementations

impl Clone for RulesFile

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RulesFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RulesFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RulesFile

where RulesFile: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RulesFile

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RulesFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RulesFile