Struct RuleSpec 

pub struct RuleSpec {
    pub id: String,
    pub kind: String,
    pub level: Level,
    pub paths: Option<PathsSpec>,
    pub message: Option<String>,
    pub policy_url: Option<String>,
    pub when: Option<String>,
    pub fix: Option<FixSpec>,
    pub git_tracked_only: bool,
    pub extra: Mapping,
}

YAML-level description of a rule before it is instantiated into a Box<dyn Rule> by a RuleBuilder.

Fields

id: String

kind: String

level: Level

paths: Option<PathsSpec>

message: Option<String>

policy_url: Option<String>

when: Option<String>

fix: Option<FixSpec>

Optional mechanical-fix strategy. Rules whose builders understand the chosen op attach a Fixer to the built rule; rules whose kind is incompatible with the op return a config error at build time.

git_tracked_only: bool

Restrict the rule to files / directories tracked in git’s index. When true, the rule’s paths-matched entries are intersected with the set of git-tracked files; entries that exist in the walked tree but aren’t in git ls-files output are skipped. Only meaningful for rule kinds that opt in (currently the existence family — file_exists, file_absent, dir_exists, dir_absent); rule kinds that don’t support it surface a clean config error when this is true so silent mis-configuration doesn’t slip through.

Default false. Has no effect outside a git repo.

extra: Mapping

The entire YAML mapping, retained so each rule builder can deserialize its kind-specific fields without every option being represented here.

Implementations

impl RuleSpec

pub fn deserialize_options<T>(&self) -> Result<T>

where T: DeserializeOwned,

Deserialize the full spec (common + kind-specific fields) into a typed options struct. Common fields are reconstructed into the mapping so the target struct can #[derive(Deserialize)] against the whole shape when convenient.

Trait Implementations

impl Clone for RuleSpec

fn clone(&self) -> RuleSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuleSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.