Skip to main content

## LintStore

# Struct LintStore

Source

    pub struct LintStore {
        lints: Vec<&'static Lint>,
        pub(crate) pre_expansion_lint_passes: Vec<Box<dyn Fn() -> Box<dyn EarlyLintPass> + DynSend + DynSync>>,
        pub(crate) early_lint_passes: Vec<Box<dyn Fn() -> Box<dyn EarlyLintPass> + DynSend + DynSync>>,
        pub(crate) late_lint_passes: Vec<Box<dyn for<'tcx> Fn(TyCtxt<'tcx>) -> Box<dyn LateLintPass<'tcx> + 'tcx> + DynSend + DynSync>>,
        pub(crate) late_lint_mod_passes: Vec<Box<dyn for<'tcx> Fn(TyCtxt<'tcx>) -> Box<dyn LateLintPass<'tcx> + 'tcx> + DynSend + DynSync>>,
        by_name: UnordMap<String, TargetLint>,
        lint_groups: FxIndexMap<&'static str, LintGroup>,
    }

Expand description

Information about the registered lints.

## Fields§

§`lints: Vec<&'static Lint>`

Registered lints.

§`pre_expansion_lint_passes: Vec<Box<dyn Fn() -> Box<dyn EarlyLintPass> + DynSend + DynSync>>`

This lint pass kind is softly deprecated. It misses expanded code and has caused a few errors in the past. Currently, it is only used in Clippy. New implementations should avoid using this interface, as it might be removed in the future.

- See rust#69838
- See rust-clippy#5518

§`early_lint_passes: Vec<Box<dyn Fn() -> Box<dyn EarlyLintPass> + DynSend + DynSync>>`

These lint passes run on AST nodes.

§`late_lint_passes: Vec<Box<dyn for<'tcx> Fn(TyCtxt<'tcx>) -> Box<dyn LateLintPass<'tcx> + 'tcx> + DynSend + DynSync>>`

These lint passes run on HIR nodes. Each one processes an entire crate. They don’t benefit from incremental compilation. `late_lint_mod_passes` should be used in preference where possible; only use `late_lint_passes` for lints that implement `check_crate` and/or `check_crate_post` and accumulate cross-module state.

The exception is Clippy, which uses `late_lint_passes` for all late lint passes. It needs `check_crate`/`check_crate_post` for some of its lints and uses late lint passes throughout for consistency. This is ok because Clippy isn’t wired for incremental compilation.

§`late_lint_mod_passes: Vec<Box<dyn for<'tcx> Fn(TyCtxt<'tcx>) -> Box<dyn LateLintPass<'tcx> + 'tcx> + DynSend + DynSync>>`

These lint passes run on HIR nodes, and are constructed per-module (i.e. multiple times). They benefit from incremental compilation.

§`by_name: UnordMap<String, TargetLint>`

Lints indexed by name.

§`lint_groups: FxIndexMap<&'static str, LintGroup>`

Map of registered lint groups to what lints they expand to.

## Implementations§

Source§

### impl LintStore

Source

#### pub fn new() -> LintStore

Source

#### pub fn get_lints<'t>(&'t self) -> &'t [&'static Lint]

Source

#### pub fn get_lint_groups( &self, ) -> impl Iterator<Item = (&'static str, Vec<LintId>, bool)>

Source

#### pub fn get_all_group_names(&self) -> impl Iterator<Item = &'static str>

Returns all lint group names, including deprecated/aliased groups

Source

#### pub fn register_pre_expansion_lint_pass( &mut self, pass: Box<dyn Fn() -> Box<dyn EarlyLintPass> + DynSend + DynSync>, )

See the comment on `LintStore::pre_expansion_lint_passes`.

Source

#### pub fn register_early_lint_pass( &mut self, pass: Box<dyn Fn() -> Box<dyn EarlyLintPass> + DynSend + DynSync>, )

See the comment on `LintStore::early_lint_passes`.

Source

#### pub fn register_late_lint_pass( &mut self, pass: Box<dyn for<'tcx> Fn(TyCtxt<'tcx>) -> Box<dyn LateLintPass<'tcx> + 'tcx> + DynSend + DynSync>, )

See the comment on `LintStore::late_lint_passes`.

Source

#### pub fn register_late_lint_mod_pass( &mut self, pass: Box<dyn for<'tcx> Fn(TyCtxt<'tcx>) -> Box<dyn LateLintPass<'tcx> + 'tcx> + DynSend + DynSync>, )

See the comment on `LintStore::late_lint_mod_passes`.

Source

#### pub fn register_lints(&mut self, lints: &[&'static Lint])

Helper method for register_early/late_pass

Source

#### fn insert_group(&mut self, name: &'static str, group: LintGroup)

Source

#### pub fn register_group_alias( &mut self, group_name: &'static str, alias: &'static str, )

Source

#### pub fn register_group( &mut self, is_externally_loaded: bool, name: &'static str, deprecated_name: Option<&'static str>, to: Vec<LintId>, )

Source

#### pub fn register_ignored(&mut self, name: &str)

This lint should give no warning and have no effect.

This is used by rustc to avoid warning about old rustdoc lints before rustdoc registers them as tool lints.

Source

#### pub fn register_renamed(&mut self, old_name: &str, new_name: &str)

This lint has been renamed; warn about using the new name and apply the lint.

Source

#### pub fn register_removed(&mut self, name: &str, reason: &str)

Source

#### pub fn find_lints(&self, lint_name: &str) -> Option<&[LintId]>

Source

#### pub fn is_lint_group(&self, lint_name: Symbol) -> bool

True if this symbol represents a lint group name.

Source

#### pub fn check_lint_name( &self, lint_name: &str, tool_name: Option<Symbol>, registered_tools: &RegisteredTools, ) -> CheckLintNameResult<'_>

Checks the name of a lint for its existence, and whether it was renamed or removed. Generates a `Diag` containing a warning for renamed and removed lints. This is over both lint names from attributes and those passed on the command line. Since it emits non-fatal warnings and there are two lint passes that inspect attributes, this is only run from the late pass to avoid printing duplicate warnings.

Source

#### fn no_lint_suggestion( &self, lint_name: &str, tool_name: &str, ) -> CheckLintNameResult<'_>

Source

#### fn check_tool_name_for_backwards_compat( &self, lint_name: &str, tool_name: &str, ) -> CheckLintNameResult<'_>

## Trait Implementations§

Source§

### impl DynLintStore for LintStore

Source§

#### fn lint_groups_iter(&self) -> Box<dyn Iterator<Item = LintGroup> + '_>

Provides a way to access lint groups without depending on `rustc_lint`

## Auto Trait Implementations§

§

### impl !RefUnwindSafe for LintStore

§

### impl !Send for LintStore

§

### impl !Sync for LintStore

§

### impl !UnwindSafe for LintStore

§

### impl DynSend for LintStore

§

### impl DynSync for LintStore

§

### impl Freeze for LintStore

§

### impl Unpin for LintStore

§

### impl UnsafeUnpin for LintStore

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<T> ErasedDestructor for T
where T: 'static,

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<K> IntoQueryKey<K> for K

Source§

#### fn into_query_key(self) -> K

Argument conversion from `Self` to `K`. This should always be a very cheap conversion, e.g. `LocalDefId::to_def_id`.
Source§

### impl<T> MaybeResult<T> for T

Source§

#### type Error = !

Source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

Source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 208 bytes