Struct Rule 

pub struct Rule {
    pub id: String,
    pub ecosystem: String,
    pub kind: Kind,
    pub markers: Vec<String>,
    pub markers_required: MarkersRequired,
    pub targets: Vec<String>,
    pub anchor: Anchor,
    pub note: Option<String>,
}

One marker-anchored rule: the evidence that a project is of some kind, and the directories that kind of project generates.

Fields

id: String

Stable identifier. A user rule with the same id replaces the built-in one.

ecosystem: String

Human-readable name of the ecosystem: the first half of the label.

kind: Kind

What the directories this rule claims are: the second half of the label.

A rule whose targets do not all share one kind is two rules, which is why python and python-caches are separate and why gradle’s build and .gradle are. One rule covering both could only label one of them honestly.

markers: Vec<String>

File or directory names proving the anchor is a project of this kind. A name containing * or ? is a glob and costs a directory listing to check.

markers_required: MarkersRequired

Whether one marker is enough.

targets: Vec<String>

Reclaimable paths relative to the anchor. Multi-segment paths (vendor/bundle) and a globbed final segment (bazel-*) are both allowed.

anchor: Anchor

Where the markers are looked for.

note: Option<String>

An optional caveat to surface next to the hit.

Implementations

impl Rule

pub fn label(&self) -> String

What the directories this rule claims are, named: the ecosystem and the kind.

Composed rather than written out per rule, because thirty hand-written strings are thirty chances to drift apart — and because the half that a reader groups by has to be the same word every time it appears.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Rule

impl PartialEq for Rule

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Rule