Struct Config

pub struct Config { /* private fields */ }

Implementations

impl Config

pub fn from_config_file<P: AsRef<Path>>(config_file: P) -> Result<Self>

Read the rule configuration from a TOML file.

The configuration file is a TOML file that contains a table of rule settings. Each rule has a unique name, and each rule can have a set of settings that are specific to that rule.

The setting named level is reserved for setting the rule’s severity level.

Rules can be turned off by setting the rule to false.

The configuration file can also include other files using the include() function. This allows for modular configuration, where each rule can be defined in a separate file, and then included into the main configuration file.

Example:

[Rule001SomeRule]
level = "error"
option1 = true
option2 = "value"

Rule002SomeOtherRule = "include('some_other_rule.toml')"

Rule003NotApplied = false

pub fn from_serializable<T: Serialize>( config: T, config_dir: &ConfigDir, ) -> Result<Self>

pub fn is_ignored(&self, path: &Path) -> bool

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.