Struct PackRules 

pub struct PackRules {
    pub custom_secret_count: usize,
    pub custom_keep_count: usize,
    pub custom_cache_count: usize,
    /* private fields */
}

Compiled classification rules used by the scan.

Fields

custom_secret_count: usize

How many of the compiled patterns came from the operator, for reporting.

custom_keep_count: usize

How many keep patterns came from the operator, for reporting.

custom_cache_count: usize

How many cache directory names came from the operator, for reporting.

Implementations

impl PackRules

pub fn new(overrides: &RuleOverrides) -> Result<Self, PackError>

Compile the built-in rules plus the operator’s additions.

Arguments

• overrides — Extra globs and directory names from [pack].

Returns

Rules ready to classify file names.

Errors

PackError::BadPattern when an operator-supplied glob is malformed, naming the offending pattern. A typo in config must fail loudly rather than silently classifying nothing.

pub fn is_cache_dir(&self, name: &str) -> bool

Whether a directory name is a regenerable cache.

pub fn secret_reason(&self, name: &str) -> Option<String>

Whether a file name must be treated as a secret, and which rule said so.

Arguments

• name — File name, not a path.

Returns

Some(reason) naming the matched glob when the file must not be packed.

pub fn secret_pattern_count(&self) -> usize

Total number of secret patterns in force.

pub fn is_customized(&self) -> bool

Whether the operator customized anything.

Trait Implementations

impl Clone for PackRules

fn clone(&self) -> PackRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackRules

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

Formats the value using the given formatter.

impl Default for PackRules

fn default() -> Self

Returns the “default value” for a type.