Struct Rule 

pub struct Rule {
    pub name: &'static str,
    pub default: Level,
    pub side: Side,
    pub surfaces: Surfaces,
}

One rule: the name it is reported and configured under, the level a project that says nothing about it gets, which half implements it, and where the name is taken.

Fields

name: &'static str

The one spelling of this rule everywhere it can be named: a report’s [htl <name>] suffix, [lint.rules], --lint, HTL_LINTS, -- htl: allow(...), and the fix filters. A tl: prefix marks a name the Teal compiler gave rather than htl.

default: Level

What a check says under this name for a project that configures nothing. A Surfaces::FixOnly rule is Level::Allow, which is not a placeholder: no check reports under it, so “nothing is said under this name” is the true answer, and it is the answer nothing can change — the listing does not print it and a spec refuses to set it.

side: Side

Which half of htl implements it, and so where a finding under it comes from. Not a setting — a project cannot move a rule from one side to the other — but it is what decides which selection table a run hands the name to.

surfaces: Surfaces

Which of the two name surfaces may contain it. See Surfaces.

Implementations

impl Rule

pub fn is_lint(&self) -> bool

Whether the listing prints this rule and a spec may set its level.

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 Copy for Rule

impl Debug for Rule

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

Formats the value using the given formatter.