Struct Configuration 

pub struct Configuration {
    pub ignore: HashSet<String>,
    pub max_db_age_days: Option<u64>,
    pub ignore_comments: HashMap<String, String>,
}

Configuration loaded from a .gem-audit.yml file.

Fields

ignore: HashSet<String>

Advisory IDs to ignore during scanning.

max_db_age_days: Option<u64>

Maximum database age in days before warning.

ignore_comments: HashMap<String, String>

Inline comments parsed from the YAML file (advisory ID → comment text).

Implementations

impl Configuration

pub const DEFAULT_FILE: &str = ".gem-audit.yml"

The default configuration file name.

pub const LEGACY_FILE: &str = ".bundler-audit.yml"

Legacy configuration file name for backward compatibility.

pub fn load(path: &Path) -> Result<Self, ConfigError>

Load configuration from a YAML file.

Returns an error if the file exists but contains invalid content.

pub fn load_or_default(path: &Path) -> Result<Self, ConfigError>

Load configuration from a YAML file path, returning a default configuration if the file does not exist.

When the primary path does not exist and its file name matches the default (.gem-audit.yml), the legacy name (.bundler-audit.yml) is tried in the same directory for backward compatibility.

pub fn save( &self, path: &Path, comments: Option<&HashMap<String, String>>, ) -> Result<(), ConfigError>

Save configuration to a YAML file.

Writes the ignore list and optional max_db_age_days in a stable, sorted order so that diffs are minimal across runs.

An optional comments map can annotate each advisory ID with context (e.g. gem name, version, criticality).

pub fn from_yaml(yaml: &str) -> Result<Self, ConfigError>

Parse configuration from a YAML string.

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Configuration

Returns the “default value” for a type.