Trait libslide::diagnostics::DiagnosticRecord

pub trait DiagnosticRecord {
    const CODE: &'static str;
    const EXPLANATION: &'static str;
}

Describes a code and detailed explanation for a diagnostic.

Associated Constants

const CODE: &'static str

Diagnostic code.

const EXPLANATION: &'static str

Detailed diagnostic explanation.

Loading content...

Implementors

impl DiagnosticRecord for ExpectedExpr

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for ExtraTokens

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for IllegalPattern

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for IllegalVariable

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for MismatchedClosingDelimiter

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for UnmatchedClosingDelimiter

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for IncompatibleDefinitions

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for MaybeIncompatibleDefinitions

const CODE: &'static str

const EXPLANATION: &'static str

impl DiagnosticRecord for InvalidToken

const CODE: &'static str

const EXPLANATION: &'static str

impl<'a> DiagnosticRecord for SimilarNamesLinter<'a>

The similar names lint detects expression patterns with very similar names.

For example, the following pattern expression has different patterns with the same suffix "a":

$a + #a + _a + $a

While this is expression is semantically valid, it can be difficuly to read and misleading, since "a" is used in three separate and independent patterns. A clearer expression would be

$a + #b + _c + $a

const CODE: &'static str

const EXPLANATION: &'static str

impl<'a> DiagnosticRecord for HomogenousAssignmentLinter<'a>

The homogenous assignment lint detects and warns on mixed use of assignment operators.

For example, the following program uses both the equality and assign-define operators to assign variables:

a = 1
b := 1

This can be misleading or confusing, as these two operators are syntactically different (and semantically different in canonical mathematics notation), but are treated the same in slide.

For this reason, it is suggested that exclusively = or := are used for assignments in slide programs.

const CODE: &'static str

const EXPLANATION: &'static str

impl<'a> DiagnosticRecord for RedundantNestingLinter<'a>

The redundant nesting lint detects redundant nesting of expressions in parantheses or brackets.

For example, the following nestings are redundant and can be reduced to a single nesting:

((1))     -> (1)
[[1]]     -> [1]
([[(1)]]) -> (1)

Redundant nestings are difficult to read and may be misleading, as generally a single nesting is expected to host an expression for precedence or clarity reasons.

const CODE: &'static str

const EXPLANATION: &'static str

impl<'a> DiagnosticRecord for UnarySeriesLinter<'a>

The unary series lint detects trivially-reducible chains of unary operators.

For example, the following chains of unary expressions can be reduced to a more trivial form:

---1   -> -1
+++1   ->  1
+-+-+- -> -1

Chaining unary operators is not standard style in mathematical expressions and can be misleading. For example, --x may be interpreted to be the prefix decrement operator available in some computer programming languages, which is absent in canonical mathematical notation.

const CODE: &'static str

const EXPLANATION: &'static str

Loading content...