Struct LintConfiguration

pub struct LintConfiguration {
    pub options: LintRuleConfiguration,
    pub groups: Vec<LintGroup>,
    pub disabled_rules: Vec<String>,
    pub enabled_rules: Vec<String>,
}

Configuration options for linting.

The options allow to

• configure the general lint rule behavior,
• explicitly enable or disable individual lint rules,
• and enable non-default lint groups.

Fields

options: LintRuleConfiguration

All options that can be used to configure various lint rules.

groups: Vec<LintGroup>

All non-default groups that are additionally enabled.

disabled_rules: Vec<String>

A list of lint rules that are explicitly disabled.

enabled_rules: Vec<String>

A list of lint rules that are explicitly enabled.

Implementations

impl LintConfiguration

pub fn from_path(path: &Path) -> Result<Self, Error>

Loads a LintConfiguration from a TOML configuration file.

Reads the file at the specified path and parses it as TOML to create a configuration instance.

Examples

use alpm_lint_config::LintConfiguration;

// Load configuration from a TOML file containing the default configuration.
let config = LintConfiguration::from_path(&config_path)?;

// The configuration is now available for use
assert_eq!(config, LintConfiguration::default());

Errors

Returns an error if:

• the file at path cannot be opened for reading,
• the file contents cannot be read,
• or the file contents cannot be parsed as valid TOML.

Trait Implementations

impl Clone for LintConfiguration

fn clone(&self) -> LintConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LintConfiguration

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

Formats the value using the given formatter.

impl Default for LintConfiguration

fn default() -> LintConfiguration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LintConfiguration

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LintConfiguration

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LintConfiguration

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LintConfiguration