Trait rustc_lint::LintContext

pub trait LintContext: Sized {
    type PassObject: LintPassObject;

    // Required methods
    fn sess(&self) -> &Session;
    fn lints(&self) -> &LintStore;
    fn lookup<S: Into<MultiSpan>>(
        &self,
        lint: &'static Lint,
        span: Option<S>,
        msg: impl Into<DiagnosticMessage>,
        decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()>
    );
    fn get_lint_level(&self, lint: &'static Lint) -> Level;

    // Provided methods
    fn lookup_with_diagnostics(
        &self,
        lint: &'static Lint,
        span: Option<impl Into<MultiSpan>>,
        msg: impl Into<DiagnosticMessage>,
        decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()>,
        diagnostic: BuiltinLintDiagnostics
    ) { ... }
    fn emit_spanned_lint<S: Into<MultiSpan>>(
        &self,
        lint: &'static Lint,
        span: S,
        decorator: impl for<'a> DecorateLint<'a, ()>
    ) { ... }
    fn struct_span_lint<S: Into<MultiSpan>>(
        &self,
        lint: &'static Lint,
        span: S,
        msg: impl Into<DiagnosticMessage>,
        decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()>
    ) { ... }
    fn emit_lint(
        &self,
        lint: &'static Lint,
        decorator: impl for<'a> DecorateLint<'a, ()>
    ) { ... }
    fn lint(
        &self,
        lint: &'static Lint,
        msg: impl Into<DiagnosticMessage>,
        decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()>
    ) { ... }
    fn fulfill_expectation(&self, expectation: LintExpectationId) { ... }
}

Required Associated Types

type PassObject: LintPassObject

Required Methods

fn sess(&self) -> &Session

fn lints(&self) -> &LintStore

fn lookup<S: Into<MultiSpan>>( &self, lint: &'static Lint, span: Option<S>, msg: impl Into<DiagnosticMessage>, decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()> )

Emit a lint at the appropriate level, with an optional associated span.

Return value of the decorate closure is ignored, see struct_lint_level for a detailed explanation.

fn get_lint_level(&self, lint: &'static Lint) -> Level

This returns the lint level for the given lint at the current location.

Provided Methods

fn lookup_with_diagnostics( &self, lint: &'static Lint, span: Option<impl Into<MultiSpan>>, msg: impl Into<DiagnosticMessage>, decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()>, diagnostic: BuiltinLintDiagnostics )

Emit a lint at the appropriate level, with an optional associated span and an existing diagnostic.

Return value of the decorate closure is ignored, see struct_lint_level for a detailed explanation.

fn emit_spanned_lint<S: Into<MultiSpan>>( &self, lint: &'static Lint, span: S, decorator: impl for<'a> DecorateLint<'a, ()> )

Emit a lint at span from a lint struct (some type that implements DecorateLint, typically generated by #[derive(LintDiagnostic)]).

fn struct_span_lint<S: Into<MultiSpan>>( &self, lint: &'static Lint, span: S, msg: impl Into<DiagnosticMessage>, decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()> )

Emit a lint at the appropriate level, with an associated span.

Return value of the decorate closure is ignored, see struct_lint_level for a detailed explanation.

fn emit_lint( &self, lint: &'static Lint, decorator: impl for<'a> DecorateLint<'a, ()> )

Emit a lint from a lint struct (some type that implements DecorateLint, typically generated by #[derive(LintDiagnostic)]).

fn lint( &self, lint: &'static Lint, msg: impl Into<DiagnosticMessage>, decorate: impl for<'a, 'b> FnOnce(&'b mut DiagnosticBuilder<'a, ()>) -> &'b mut DiagnosticBuilder<'a, ()> )

Emit a lint at the appropriate level, with no associated span.

Return value of the decorate closure is ignored, see struct_lint_level for a detailed explanation.

fn fulfill_expectation(&self, expectation: LintExpectationId)

This function can be used to manually fulfill an expectation. This can be used for lints which contain several spans, and should be suppressed, if either location was marked with an expectation.

Note that this function should only be called for LintExpectationIds retrieved from the current lint pass. Buffered or manually created ids can cause ICEs.

Implementors

impl LintContext for EarlyContext<'_>

type PassObject = Box<dyn EarlyLintPass, Global>

impl<'tcx> LintContext for LateContext<'tcx>

type PassObject = Box<dyn LateLintPass<'tcx> + 'tcx, Global>