Struct RedactionRule 

#[non_exhaustive]
pub struct RedactionRule {
    pub name: String,
    pub pattern: String,
}

One user-defined secret detector ([redaction] rules, see docs/redaction-design.md). The pattern is compiled by crate::redact::Detectors::new; an invalid regex is an actionable error there, not a silent no-op.

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.

name: String

Short rule name; findings report as custom:<name>.

pattern: String

The regex to match (Rust regex syntax, linear-time).

Trait Implementations

impl Clone for RedactionRule

fn clone(&self) -> RedactionRule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RedactionRule

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

Formats the value using the given formatter.

impl Eq for RedactionRule

impl PartialEq for RedactionRule

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RedactionRule