Struct RuleConfig 

pub struct RuleConfig {
    pub severity: RuleSeverity,
    pub files: Vec<String>,
    pub ignore: Vec<String>,
    pub command: Option<String>,
    pub options: Option<Value>,
    /* private fields */
}

Configuration for a single rule under [rules]. Supports shorthand (cycle = "warn") and table form ([rules.orphan]).

Fields

severity: RuleSeverity

files: Vec<String>

Scope which nodes the rule evaluates (default: all).

ignore: Vec<String>

Exclude nodes from diagnostics (default: none).

command: Option<String>

options: Option<Value>

Arbitrary structured data passed through to the rule. drft doesn’t interpret it.

Implementations

impl RuleConfig

pub fn new( severity: RuleSeverity, files: Vec<String>, ignore: Vec<String>, command: Option<String>, options: Option<Value>, ) -> Result<Self>

pub fn is_path_in_scope(&self, path: &str) -> bool

pub fn is_path_ignored(&self, path: &str) -> bool

Trait Implementations

impl Clone for RuleConfig

fn clone(&self) -> RuleConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleConfig

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

Formats the value using the given formatter.

impl Serialize for RuleConfig

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.