Struct rusty_hogs::SecretScannerBuilder

pub struct SecretScannerBuilder {
    pub case_insensitive: bool,
    pub regex_json_str: Option<String>,
    pub regex_json_path: Option<String>,
    pub pretty_print: bool,
    pub output_path: Option<String>,
}

Used to instantiate the SecretScanner object with user-supplied options

Use the new() function to create a builder object, perform configurations as needed, then create the SecretScanner object with .build(). Each configuration method consumes and returns self so that you can chain them.

Examples

With no configuration you will inherit the default rules that are case sensitive...

use rusty_hogs::{SecretScannerBuilder, SecretScanner};
let ssb: SecretScannerBuilder = SecretScannerBuilder::new();
let ss: SecretScanner = ssb.build();
assert_ne!(ss.regex_map.len(), 0);

Alternatively, you can supply your own regular expression JSON, and set a global case-insensitive flag...

use rusty_hogs::{SecretScannerBuilder, SecretScanner};
let regex_string = r##"{ "Phone number" : "\\d{3}-?\\d{3}-\\d{4}" }"##;
let ssb: SecretScannerBuilder = SecretScannerBuilder::new()
    .set_json_str(regex_string)
    .global_case_insensitive(true);
assert!(ssb.case_insensitive);
let ss: SecretScanner = ssb.build();
assert_eq!(ss.regex_map.len(), 1);

Fields

case_insensitive: bool

regex_json_str: Option<String>

regex_json_path: Option<String>

pretty_print: bool

output_path: Option<String>

Methods

impl SecretScannerBuilder

pub fn new() -> Self

Create a new SecretScannerBuilder object with the default config (50 rules, case sensitive)

pub fn conf_argm(self, arg_matches: &ArgMatches) -> Self

Configure multiple values using the clap library's ArgMatches object. This function looks for a "CASE" flag and "REGEX" value.

pub fn set_json_path(self, json_path: &str) -> Self

Supply a path to a JSON file on the system that contains regular expressions

pub fn set_json_str(self, json_str: &str) -> Self

Supply a string containing a JSON object that contains regular expressions

pub fn global_case_insensitive(self, case_insensitive: bool) -> Self

Force all regular expressions to be case-insensitive, overriding any flags in the regex

pub fn set_pretty_print(self, pretty_print: bool) -> Self

Set output format to pretty printed JSON

pub fn set_output_path(self, output_path: &str) -> Self

Set output path (stdout if set to None)

pub fn build(&self) -> SecretScanner

Returns the configured SecretScanner object used to perform regex scanning

Trait Implementations

impl Clone for SecretScannerBuilder

fn clone(&self) -> SecretScannerBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretScannerBuilder

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

Formats the value using the given formatter.

impl Default for SecretScannerBuilder

fn default() -> Self

Returns the "default value" for a type.

impl Eq for SecretScannerBuilder

impl Hash for SecretScannerBuilder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<SecretScannerBuilder> for SecretScannerBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for SecretScannerBuilder

impl StructuralPartialEq for SecretScannerBuilder