Struct Directive 

pub struct Directive<'a> {
    pub tool: Tool,
    pub verb: Verb,
    pub prefix: TextRange,
    pub scope: RuleScope,
    pub reason: Option<&'a str>,
    pub spelling: Spelling,
}

A recognized directive.

Fields

tool: Tool

verb: Verb

prefix: TextRange

The tool prefix as written — arity-lint, arity-format, arity, or a deprecated arity-ignore/arity-ignore-file. A rule that rewrites the spelling replaces exactly these bytes and leaves the rest alone.

scope: RuleScope

reason: Option<&'a str>

The text after the :, trimmed. None when there is no :, or nothing but whitespace follows it.

spelling: Spelling

Implementations

impl Directive<'_>

pub fn rule(&self) -> Option<&RuleRef>

The rule the author named, if they named one.

pub fn has_rule_slot(&self) -> bool

Whether the rule slot means anything here. A format-only directive names no rule because it cannot, and an on closes whatever is open rather than naming anything — neither is an author who forgot.

Trait Implementations

impl<'a> Clone for Directive<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Directive<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Directive<'a>

impl<'a> PartialEq for Directive<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Directive<'a>