Expand description
Lints in the Rust compiler.
This contains lints which can feasibly be implemented as their own
AST visitor. Also see rustc_session::lint::builtin
, which contains the
definitions of lints that are emitted directly inside the main compiler.
To add a new lint to rustc, declare it here using declare_lint!
.
Then add code to emit the new lint in the appropriate circumstances.
If you define a new EarlyLintPass
, you will also need to add it to the
crate::early_lint_methods!
invocation in lib.rs
.
If you define a new LateLintPass
, you will also need to add it to the
crate::late_lint_methods!
invocation in lib.rs
.
Structsยง
- Checks for use of anonymous parameters (RFC 1685).
- Check for use of attributes which have been deprecated.
- Does nothing as a lint pass, but registers some
Lint
s that are used by other parts of the compiler. - Check for used feature gates in
INCOMPLETE_FEATURES
inrustc_feature/src/unstable.rs
. - Information about why a type cannot be initialized this way.
- Check for uses of edition keywords used as an identifier.
- Does nothing as a lint pass, but registers some
Lint
s which are used by other parts of the compiler. - Lint for trait and lifetime bounds that donโt depend on type parameters which either do nothing, or stop the item from being used.
- Under
Macro ๐ - Explains corresponding feature flag must be enabled for the
#[track_caller]
attribute to do anything - Lint for items marked
pub
that arenโt reachable from other crates. - Forbids using the
#[feature(...)]
attribute
Enumsยง
- AsmLabel
Kind ๐
Constantsยง
- HAS_
MIN_ ๐FEATURES
Staticsยง
- The
abi_unsupported_vector_types
lint detects function definitions and calls whose ABI depends on enabling certain target features, but those features are not enabled. - The
absolute_paths_not_starting_with_crate
lint detects fully qualified paths that start with a module name instead ofcrate
,self
, or an extern crate name - The
ambiguous_glob_imports
lint detects glob imports that should report ambiguity errors, but previously didnโt do that due to rustc bugs. - The
ambiguous_glob_reexports
lint detects cases where names re-exported via globs collide. Downstream users trying to use the same name re-exported from multiple globs will receive a warning pointing out redefinition of the same name. - The
anonymous_parameters
lint detects anonymous parameters in trait definitions. - The
arithmetic_overflow
lint detects that an arithmetic operation will overflow. - The
asm_sub_register
lint detects using only a subset of a register for inline asm inputs. - The
bad_asm_style
lint detects the use of the.intel_syntax
and.att_syntax
directives. - The
bare_trait_objects
lint suggests usingdyn Trait
for trait objects. - The
binary_asm_labels
lint detects the use of numeric labels containing only binary digits in the inlineasm!
macro. - The
bindings_with_variant_name
lint detects pattern bindings with the same name as one of the matched variants. - The
break_with_label_and_loop
lint detects labeledbreak
expressions with an unlabeled loop as their value expression. - The
coherence_leak_check
lint detects conflicting implementations of a trait that are only distinguished by the old leak-check code. - The
conflicting_repr_hints
lint detectsrepr
attributes with conflicting hints. - The
const_evaluatable_unchecked
lint detects a generic constant used in a type. - The
const_item_mutation
lint detects attempts to mutate aconst
item. - The
dead_code
lint detects unused, unexported items. - The
dependency_on_unit_never_type_fallback
lint detects cases where code compiles with never type fallback being()
, but will stop compiling with fallback being!
. - The
deprecated
lint detects use of deprecated items. - The
deprecated_in_future
lint is internal to rustc and should not be used by user code. - The
deprecated_safe_2024
lint detects unsafe functions being used as safe functions. - The
deprecated_where_clause_location
lint detects when a where clause in front of the equals in an associated type. - The
deref_nullptr
lint detects when an null pointer is dereferenced, which causes undefined behavior. - The
duplicate_macro_attributes
lint detects when a#[test]
-like built-in macro attribute is duplicated on an item. This lint may trigger onbench
,cfg_eval
,test
andtest_case
. - The
elided_lifetimes_in_associated_constant
lint detects elided lifetimes in associated constants when there are other lifetimes in scope. This was accidentally supported, and this lint was later relaxed to allow eliding lifetimes to'static
when there are no lifetimes in scope. - The
elided_lifetimes_in_paths
lint detects the use of hidden lifetime parameters. - The
elided_named_lifetimes
lint detects when an elided lifetime ends up being a named lifetime, such as'static
or some lifetime parameter'a
. - The
ellipsis_inclusive_range_patterns
lint detects the...
range pattern, which is deprecated. - The
explicit_builtin_cfgs_in_flags
lint detects builtin cfgs set via the--cfg
flag. - The
explicit_outlives_requirements
lint detects unnecessary lifetime bounds that can be inferred. - The
exported_private_dependencies
lint detects private dependencies that are exposed in a public interface. - The
ffi_unwind_calls
lint detects calls to foreign functions or function pointers withC-unwind
or other FFI-unwind ABIs. - The
forbidden_lint_groups
lint detects violations offorbid
applied to a lint group. Due to a bug in the compiler, these used to be overlooked entirely. They now generate a warning. - The
function_item_references
lint detects function references that are formatted withfmt::Pointer
or transmuted. - The
fuzzy_provenance_casts
lint detects anas
cast between an integer and a pointer. - The
hidden_glob_reexports
lint detects cases where glob re-export items are shadowed by private items. - The
ill_formed_attribute_input
lint detects ill-formed attribute inputs that were previously accepted and used in practice. - The
incomplete_features
lint detects unstable features enabled with thefeature
attribute that may function improperly in some or all cases. - The
incomplete_include
lint detects the use of theinclude!
macro with a file that contains more than one expression. - The
ineffective_unstable_trait_impl
lint detects#[unstable]
attributes which are not used. - The
internal_features
lint detects unstable features enabled with thefeature
attribute that are internal to the compiler or standard library. - The
invalid_doc_attributes
lint detects when the#[doc(...)]
is misused. - The
invalid_macro_export_arguments
lint detects cases where#[macro_export]
is being used with invalid arguments. - The
invalid_type_param_default
lint detects type parameter defaults erroneously allowed in an invalid location. - The
invalid_value
lint detects creating a value that is not valid, such as a null reference. - The
irrefutable_let_patterns
lint detects irrefutable patterns inif let
s,while let
s, andif let
guards. - The
keyword_idents_2018
lint detects edition keywords being used as an identifier. - The
keyword_idents_2024
lint detects edition keywords being used as an identifier. - The
large_assignments
lint detects when objects of large types are being moved around. - The
late_bound_lifetime_arguments
lint detects generic lifetime arguments in path segments with late bound lifetime parameters. - The
legacy_derive_helpers
lint detects derive helper attributes that are used before they are introduced. - The
long_running_const_eval
lint is emitted when const eval is running for a long time to ensure rustc terminates even if you accidentally wrote an infinite loop. - The
lossy_provenance_casts
lint detects anas
cast between a pointer and an integer. - The
macro_expanded_macro_exports_accessed_by_absolute_paths
lint detects macro-expandedmacro_export
macros from the current crate that cannot be referred to by absolute paths. - The
macro_use_extern_crate
lint detects the use of themacro_use
attribute. - The
meta_variable_misuse
lint detects possible meta-variable misuse in macro definitions. - The
missing_abi
lint detects cases where the ABI is omitted fromextern
declarations. - The
missing_copy_implementations
lint detects potentially-forgotten implementations ofCopy
for public types. - The
missing_debug_implementations
lint detects missing implementations offmt::Debug
for public types. - The
missing_docs
lint detects missing documentation for public items. - The
missing_fragment_specifier
lint is issued when an unused pattern in amacro_rules!
macro definition has a meta-variable (e.g.$e
) that is not followed by a fragment specifier (e.g.:expr
). - The
missing_unsafe_on_extern
lint detects missing unsafe keyword on extern declarations. - The
must_not_suspend
lint guards against values that shouldnโt be held across suspend points (.await
) - MUTABLE_
TRANSMUTES ๐ - The
named_arguments_used_positionally
lint detects cases where named arguments are only used positionally in format strings. This usage is valid but potentially very confusing. - The
named_asm_labels
lint detects the use of named labels in the inlineasm!
macro. - The
never_type_fallback_flowing_into_unsafe
lint detects cases where never type fallback affects unsafe function calls. - The
non_contiguous_range_endpoints
lint detects likely off-by-one errors when using exclusive range patterns. - The
non_exhaustive_omitted_patterns
lint aims to help consumers of a#[non_exhaustive]
struct or enum who want to match all of its fields/variants explicitly. - The
non_shorthand_field_patterns
lint detects usingStruct { x: x }
instead ofStruct { x }
in a pattern. - The
no_mangle_generic_items
lint detects generic items that must be mangled. - The
order_dependent_trait_objects
lint detects a trait coherency violation that would allow creating two trait impls for the same dynamic trait object involving marker traits. - The
out_of_scope_macro_calls
lint detectsmacro_rules
called when they are not in scope, above their definition, which may happen in key-value attributes. - The
overlapping_range_endpoints
lint detectsmatch
arms that have range patterns that overlap on their endpoints. - The
patterns_in_fns_without_body
lint detectsmut
identifier patterns as a parameter in functions without a body. - The
private_bounds
lint detects types in a secondary interface of an item, that are more private than the item itself. Secondary interface of an item consists of bounds on generic parameters and where clauses, including supertraits for trait items. - The
private_interfaces
lint detects types in a primary interface of an item, that are more private than the item itself. Primary interface of an item is all its interface except for bounds on generic parameters and where clauses. - The
private_macro_use
lint detects private macros that are imported with#[macro_use]
. - The
proc_macro_derive_resolution_fallback
lint detects proc macro derives using inaccessible names from parent modules. - The
ptr_cast_add_auto_to_object
lint detects casts of raw pointers to trait objects, which add auto traits. - The
ptr_to_integer_transmute_in_consts
lint detects pointer to integer transmute in const functions and associated constants. - The
pub_use_of_private_extern_crate
lint detects a specific situation of re-exporting a privateextern crate
. - The
redundant_imports
lint detects imports that are redundant due to being imported already; either through a previous import, or being present in the prelude. - The
redundant_lifetimes
lint detects lifetime parameters that are redundant because they are equal to another named lifetime. - The
refining_impl_trait_internal
lint detectsimpl Trait
return types in method signatures that are refined by a trait implementation, meaning the implementation adds information about the return type that is not present in the trait. - The
refining_impl_trait_reachable
lint detectsimpl Trait
return types in method signatures that are refined by a publically reachable trait implementation, meaning the implementation adds information about the return type that is not present in the trait. - The
renamed_and_removed_lints
lint detects lints that have been renamed or removed. - The
repr_transparent_external_private_fields
lint detects types marked#[repr(transparent)]
that (transitively) contain an external ZST type marked#[non_exhaustive]
or containing private fields - The
rust_2021_incompatible_closure_captures
lint detects variables that arenโt completely captured in Rust 2021, such that theDrop
order of their fields may differ between Rust 2018 and 2021. - The
rust_2021_incompatible_or_patterns
lint detects usage of old versions of or-patterns. - The
rust_2021_prefixes_incompatible_syntax
lint detects identifiers that will be parsed as a prefix instead in Rust 2021. - The
rust_2021_prelude_collisions
lint detects the usage of trait methods which are ambiguous with traits added to the prelude in future editions. - The
rust_2024_guarded_string_incompatible_syntax
lint detects#
tokens that will be parsed as part of a guarded string literal in Rust 2024. - The
rust_2024_incompatible_pat
lint detects patterns whose meaning will change in the Rust 2024 edition. - The
rust_2024_prelude_collisions
lint detects the usage of trait methods which are ambiguous with traits added to the prelude in future editions. - The
self_constructor_from_outer_item
lint detects cases where theSelf
constructor was silently allowed due to a bug in the resolver, and which may produce surprising and unintended behavior. - The
semicolon_in_expressions_from_macros
lint detects trailing semicolons in macro bodies when the macro is invoked in expression position. This was previous accepted, but is being phased out. - The
single_use_lifetimes
lint detects lifetimes that are only used once. - The
soft_unstable
lint detects unstable features that were unintentionally allowed on stable. - The
special_module_name
lint detects module declarations for files that have a special meaning. - The
stable_features
lint detects afeature
attribute that has since been made stable. - The
tail_expr_drop_order
lint looks for those values generated at the tail expression location, that runs a customDrop
destructor. Some of them may be dropped earlier in Edition 2024 that they used to in Edition 2021 and prior. This lint detects those cases and provides you information on those values and their custom destructor implementations. Your discretion on this information is required. - The
test_unstable_lint
lint tests unstable lints and is perma-unstable. - The
text_direction_codepoint_in_comment
lint detects Unicode codepoints in comments that change the visual representation of text on screen in a way that does not correspond to their on memory representation. - TRIVIAL_
BOUNDS ๐Thetrivial_bounds
lint detects trait bounds that donโt depend on any type parameters. - The
trivial_casts
lint detects trivial casts which could be replaced with coercion, which may require a temporary variable. - The
trivial_numeric_casts
lint detects trivial numeric casts of types which could be removed. - TYPE_
ALIAS_ ๐BOUNDS Thetype_alias_bounds
lint detects bounds in type aliases. - The
tyvar_behind_raw_pointer
lint detects raw pointer to an inference variable. - The
unconditional_panic
lint detects an operation that will cause a panic at runtime. - The
unconditional_recursion
lint detects functions that cannot return without calling themselves. - The
uncovered_param_in_projection
lint detects a violation of one of Rustโs orphan rules for foreign trait implementations that concerns the use of type parameters inside trait associated type paths (โprojectionsโ) whose output may not be a local type that is mistakenly considered to โcoverโ said parameters which is unsound and which may be rejected by a future version of the compiler. - The
undefined_naked_function_abi
lint detects naked function definitions that either do not specify an ABI or specify the Rust ABI. - The
unexpected_cfgs
lint detects unexpected conditional compilation conditions. - The
unfulfilled_lint_expectations
lint detects when a lint expectation is unfulfilled. - The
ungated_async_fn_track_caller
lint warns when the#[track_caller]
attribute is used on an async function without enabling the corresponding unstable feature flag. - The
uninhabited_static
lint detects uninhabited statics. - The
unknown_crate_types
lint detects an unknown crate type found in acrate_type
attribute. - The
unknown_lints
lint detects unrecognized lint attributes. - The
unknown_or_malformed_diagnostic_attributes
lint detects unrecognized or otherwise malformed diagnostic attributes. - The
unnameable_test_items
lint detects#[test]
functions that are not able to be run by the test harness because they are in a position where they are not nameable. - The
unnameable_types
lint detects types for which you can get objects of that type, but cannot name the type itself. - The
unreachable_code
lint detects unreachable code paths. - The
unreachable_patterns
lint detects unreachable patterns. - The
unreachable_pub
lint triggers forpub
items not reachable from other crates - that means neither directly accessible, nor reexported, nor leaked through things like return types. - The
unsafe_attr_outside_unsafe
lint detects a missing unsafe keyword on attributes considered unsafe. - UNSAFE_
CODE ๐Theunsafe_code
lint catches usage ofunsafe
code and other potentially unsound constructs likeno_mangle
,export_name
, andlink_section
. - The
unsafe_op_in_unsafe_fn
lint detects unsafe operations in unsafe functions without an explicit unsafe block. - UNSTABLE_
FEATURES ๐Theunstable_features
lint detects uses of#![feature]
. - The
unstable_name_collisions
lint detects that you have used a name that the standard library plans to add in the future. - The
unstable_syntax_pre_expansion
lint detects the use of unstable syntax that is discarded during attribute expansion. - The
unsupported_fn_ptr_calling_conventions
lint is output whenever there is a use of a target dependent calling convention on a target that does not support this calling convention on a function pointer. - The
unused_assignments
lint detects assignments that will never be read. - The
unused_associated_type_bounds
lint is emitted when an associated type bound is added to a trait object, but the associated type has awhere Self: Sized
bound, and is thus unavailable on the trait object anyway. - The
unused_attributes
lint detects attributes that were not used by the compiler. - The
unused_crate_dependencies
lint detects crate dependencies that are never used. - The
unused_doc_comments
lint detects doc comments that arenโt used byrustdoc
. - The
unused_extern_crates
lint guards againstextern crate
items that are never used. - The
unused_features
lint detects unused or unknown features found in crate-levelfeature
attributes. - The
unused_imports
lint detects imports that are never used. - The
unused_labels
lint detects labels that are never used. - The
unused_lifetimes
lint detects lifetime parameters that are never used. - The
unused_macros
lint detects macros that were not used. - The
unused_macro_rules
lint detects macro rules that were not used. - The
unused_mut
lint detects mut variables which donโt need to be mutable. - The
unused_qualifications
lint detects unnecessarily qualified names. - The
unused_unsafe
lint detects unnecessary use of anunsafe
block. - The
unused_variables
lint detects variables which are not used in any way. - The
useless_deprecated
lint detects deprecation attributes with no effect. - The
warnings
lint allows you to change the level of other lints which produce warnings. - The
wasm_c_abi
lint detects crate dependencies that are incompatible with future versions of Rust that will emit spec-compliant C ABI. - WHILE_
TRUE ๐Thewhile_true
lint detectswhile true { }
.
Functionsยง
- has_doc ๐
- pierce_
parens ๐Traverse through any amount of parenthesis and return the first non-parens expression. - Check whether a
ty
has a negativeCopy
implementation, ignoring outlives constraints. - warn_
if_ ๐doc