Enum slicec::diagnostics::Lint

pub enum Lint {
    DuplicateFile {
        path: String,
    },
    Deprecated {
        identifier: String,
        reason: Option<String>,
    },
    MalformedDocComment {
        message: String,
    },
    IncorrectDocComment {
        message: String,
    },
    BrokenDocLink {
        message: String,
    },
}

Variants

DuplicateFile

Fields

path: String

The path of the file that supplied more than once.

An input filename was provided multiple times. Note: it’s valid to specify the same path as a source and reference file (ex: slicec foo.slice -R foo.slice). This is only triggered by specifying it multiple times in the same context: (ex: slicec foo.slice foo.slice).

Deprecated

Fields

identifier: String

The element’s identifier.

reason: Option<String>

The reason the element was deprecated (if specified).

A deprecated Slice element was used.

MalformedDocComment

Fields

message: String

A syntactical mistake in a doc-comment.

IncorrectDocComment

Fields

message: String

A doc comment contains an incorrect tag. Either:

• The tag itself is incorrect. Ex: using @throws on an element that can’t or doesn’t throw an exception.
• The tag describes something incorrect. Ex: specifying @param foo when no parameter named “foo” exists.

BrokenDocLink

Fields

message: String

A link in a doc-comment couldn’t be resolved. Either:

• The link pointed to an un-linkable element, e.g. a module, result, sequence, dictionary, or primitive.
• The link pointed to a non-existent element.

Implementations

impl Lint

pub fn get_default_level(&self) -> DiagnosticLevel

Returns the default diagnostic level this lint should use when reporting violations.

impl Lint

pub const ALLOWABLE_LINT_IDENTIFIERS: [&'static str; 6] = _

This array contains all the valid arguments for the ‘allow’ attribute.

pub fn code(&self) -> &str

pub fn message(&self) -> String

Trait Implementations

impl Debug for Lint

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

Formats the value using the given formatter.

impl From<Lint> for DiagnosticKind

fn from(lint: Lint) -> Self

Converts to this type from the input type.