Struct Lint

pub struct Lint {
    pub span: Span,
    pub lint_kind: LintKind,
    pub suggestions: Vec<Suggestion>,
    pub message: String,
    pub priority: u8,
}

An error found in text.

Fields

span: Span

The location in the source text the error lies. Important for automatic lint resolution through Self::suggestions.

lint_kind: LintKind

The general category the lint belongs to. Mostly used for UI elements in integrations.

suggestions: Vec<Suggestion>

A list of zero or more suggested edits that would resolve the underlying problem. See Suggestion.

message: String

A message to be displayed to the user describing the specific error found.

You may use the format macro to generate more complex messages.

priority: u8

A numerical value for the importance of a lint. Lower = more important.

Implementations

impl Lint

pub fn spanless_hash(&self) -> u64

Creates a SHA-3 hash of all elements of the lint, sans Self::span. This is useful for comparing lints while ignoring their position within the document.

Do not assume that these hash values are stable across Harper versions.

Trait Implementations

impl Clone for Lint

fn clone(&self) -> Lint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lint

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

Formats the value using the given formatter.

impl Default for Lint

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Lint

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Lint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Lint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Lint