Struct Pattern 

pub struct Pattern {
    pub name: String,
    pub regex: Regex,
}

A named regex pattern.

The name is used in the placeholder string and in ScrubReport counts. The regex is the compiled pattern.

Construct via Pattern::new.

Fields

name: String

Display name for the pattern. Appears in the placeholder.

regex: Regex

Compiled regex.

Implementations

impl Pattern

pub fn new(name: impl Into<String>, pat: &str) -> Result<Self, Error>

Compile a new named pattern.

Returns an error if the regex is invalid.

use tool_secret_scrubber::Pattern;

let p = Pattern::new("internal", r"INTL-[A-Z0-9]{6}").unwrap();
assert_eq!(p.name, "internal");

Trait Implementations

impl Clone for Pattern

fn clone(&self) -> Pattern

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pattern

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

Formats the value using the given formatter.