]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_lint_defs/src/builtin.rs
Auto merge of #86622 - FabianWolff:issue-83475, r=jonas-schievink
[rust.git] / compiler / rustc_lint_defs / src / builtin.rs
1 // ignore-tidy-filelength
2
3 //! Some lints that are built in to the compiler.
4 //!
5 //! These are the built-in lints that are emitted direct in the main
6 //! compiler code, rather than using their own custom pass. Those
7 //! lints are all available in `rustc_lint::builtin`.
8
9 use crate::{declare_lint, declare_lint_pass, FutureBreakage, FutureIncompatibilityReason};
10 use rustc_span::edition::Edition;
11
12 declare_lint! {
13     /// The `forbidden_lint_groups` lint detects violations of
14     /// `forbid` applied to a lint group. Due to a bug in the compiler,
15     /// these used to be overlooked entirely. They now generate a warning.
16     ///
17     /// ### Example
18     ///
19     /// ```rust
20     /// #![forbid(warnings)]
21     /// #![deny(bad_style)]
22     ///
23     /// fn main() {}
24     /// ```
25     ///
26     /// {{produces}}
27     ///
28     /// ### Recommended fix
29     ///
30     /// If your crate is using `#![forbid(warnings)]`,
31     /// we recommend that you change to `#![deny(warnings)]`.
32     ///
33     /// ### Explanation
34     ///
35     /// Due to a compiler bug, applying `forbid` to lint groups
36     /// previously had no effect. The bug is now fixed but instead of
37     /// enforcing `forbid` we issue this future-compatibility warning
38     /// to avoid breaking existing crates.
39     pub FORBIDDEN_LINT_GROUPS,
40     Warn,
41     "applying forbid to lint-groups",
42     @future_incompatible = FutureIncompatibleInfo {
43         reference: "issue #81670 <https://github.com/rust-lang/rust/issues/81670>",
44     };
45 }
46
47 declare_lint! {
48     /// The `ill_formed_attribute_input` lint detects ill-formed attribute
49     /// inputs that were previously accepted and used in practice.
50     ///
51     /// ### Example
52     ///
53     /// ```rust,compile_fail
54     /// #[inline = "this is not valid"]
55     /// fn foo() {}
56     /// ```
57     ///
58     /// {{produces}}
59     ///
60     /// ### Explanation
61     ///
62     /// Previously, inputs for many built-in attributes weren't validated and
63     /// nonsensical attribute inputs were accepted. After validation was
64     /// added, it was determined that some existing projects made use of these
65     /// invalid forms. This is a [future-incompatible] lint to transition this
66     /// to a hard error in the future. See [issue #57571] for more details.
67     ///
68     /// Check the [attribute reference] for details on the valid inputs for
69     /// attributes.
70     ///
71     /// [issue #57571]: https://github.com/rust-lang/rust/issues/57571
72     /// [attribute reference]: https://doc.rust-lang.org/nightly/reference/attributes.html
73     /// [future-incompatible]: ../index.md#future-incompatible-lints
74     pub ILL_FORMED_ATTRIBUTE_INPUT,
75     Deny,
76     "ill-formed attribute inputs that were previously accepted and used in practice",
77     @future_incompatible = FutureIncompatibleInfo {
78         reference: "issue #57571 <https://github.com/rust-lang/rust/issues/57571>",
79     };
80     crate_level_only
81 }
82
83 declare_lint! {
84     /// The `conflicting_repr_hints` lint detects [`repr` attributes] with
85     /// conflicting hints.
86     ///
87     /// [`repr` attributes]: https://doc.rust-lang.org/reference/type-layout.html#representations
88     ///
89     /// ### Example
90     ///
91     /// ```rust,compile_fail
92     /// #[repr(u32, u64)]
93     /// enum Foo {
94     ///     Variant1,
95     /// }
96     /// ```
97     ///
98     /// {{produces}}
99     ///
100     /// ### Explanation
101     ///
102     /// The compiler incorrectly accepted these conflicting representations in
103     /// the past. This is a [future-incompatible] lint to transition this to a
104     /// hard error in the future. See [issue #68585] for more details.
105     ///
106     /// To correct the issue, remove one of the conflicting hints.
107     ///
108     /// [issue #68585]: https://github.com/rust-lang/rust/issues/68585
109     /// [future-incompatible]: ../index.md#future-incompatible-lints
110     pub CONFLICTING_REPR_HINTS,
111     Deny,
112     "conflicts between `#[repr(..)]` hints that were previously accepted and used in practice",
113     @future_incompatible = FutureIncompatibleInfo {
114         reference: "issue #68585 <https://github.com/rust-lang/rust/issues/68585>",
115     };
116 }
117
118 declare_lint! {
119     /// The `meta_variable_misuse` lint detects possible meta-variable misuse
120     /// in macro definitions.
121     ///
122     /// ### Example
123     ///
124     /// ```rust,compile_fail
125     /// #![deny(meta_variable_misuse)]
126     ///
127     /// macro_rules! foo {
128     ///     () => {};
129     ///     ($( $i:ident = $($j:ident),+ );*) => { $( $( $i = $k; )+ )* };
130     /// }
131     ///
132     /// fn main() {
133     ///     foo!();
134     /// }
135     /// ```
136     ///
137     /// {{produces}}
138     ///
139     /// ### Explanation
140     ///
141     /// There are quite a few different ways a [`macro_rules`] macro can be
142     /// improperly defined. Many of these errors were previously only detected
143     /// when the macro was expanded or not at all. This lint is an attempt to
144     /// catch some of these problems when the macro is *defined*.
145     ///
146     /// This lint is "allow" by default because it may have false positives
147     /// and other issues. See [issue #61053] for more details.
148     ///
149     /// [`macro_rules`]: https://doc.rust-lang.org/reference/macros-by-example.html
150     /// [issue #61053]: https://github.com/rust-lang/rust/issues/61053
151     pub META_VARIABLE_MISUSE,
152     Allow,
153     "possible meta-variable misuse at macro definition"
154 }
155
156 declare_lint! {
157     /// The `incomplete_include` lint detects the use of the [`include!`]
158     /// macro with a file that contains more than one expression.
159     ///
160     /// [`include!`]: https://doc.rust-lang.org/std/macro.include.html
161     ///
162     /// ### Example
163     ///
164     /// ```rust,ignore (needs separate file)
165     /// fn main() {
166     ///     include!("foo.txt");
167     /// }
168     /// ```
169     ///
170     /// where the file `foo.txt` contains:
171     ///
172     /// ```text
173     /// println!("hi!");
174     /// ```
175     ///
176     /// produces:
177     ///
178     /// ```text
179     /// error: include macro expected single expression in source
180     ///  --> foo.txt:1:14
181     ///   |
182     /// 1 | println!("1");
183     ///   |              ^
184     ///   |
185     ///   = note: `#[deny(incomplete_include)]` on by default
186     /// ```
187     ///
188     /// ### Explanation
189     ///
190     /// The [`include!`] macro is currently only intended to be used to
191     /// include a single [expression] or multiple [items]. Historically it
192     /// would ignore any contents after the first expression, but that can be
193     /// confusing. In the example above, the `println!` expression ends just
194     /// before the semicolon, making the semicolon "extra" information that is
195     /// ignored. Perhaps even more surprising, if the included file had
196     /// multiple print statements, the subsequent ones would be ignored!
197     ///
198     /// One workaround is to place the contents in braces to create a [block
199     /// expression]. Also consider alternatives, like using functions to
200     /// encapsulate the expressions, or use [proc-macros].
201     ///
202     /// This is a lint instead of a hard error because existing projects were
203     /// found to hit this error. To be cautious, it is a lint for now. The
204     /// future semantics of the `include!` macro are also uncertain, see
205     /// [issue #35560].
206     ///
207     /// [items]: https://doc.rust-lang.org/reference/items.html
208     /// [expression]: https://doc.rust-lang.org/reference/expressions.html
209     /// [block expression]: https://doc.rust-lang.org/reference/expressions/block-expr.html
210     /// [proc-macros]: https://doc.rust-lang.org/reference/procedural-macros.html
211     /// [issue #35560]: https://github.com/rust-lang/rust/issues/35560
212     pub INCOMPLETE_INCLUDE,
213     Deny,
214     "trailing content in included file"
215 }
216
217 declare_lint! {
218     /// The `arithmetic_overflow` lint detects that an arithmetic operation
219     /// will [overflow].
220     ///
221     /// [overflow]: https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow
222     ///
223     /// ### Example
224     ///
225     /// ```rust,compile_fail
226     /// 1_i32 << 32;
227     /// ```
228     ///
229     /// {{produces}}
230     ///
231     /// ### Explanation
232     ///
233     /// It is very likely a mistake to perform an arithmetic operation that
234     /// overflows its value. If the compiler is able to detect these kinds of
235     /// overflows at compile-time, it will trigger this lint. Consider
236     /// adjusting the expression to avoid overflow, or use a data type that
237     /// will not overflow.
238     pub ARITHMETIC_OVERFLOW,
239     Deny,
240     "arithmetic operation overflows"
241 }
242
243 declare_lint! {
244     /// The `unconditional_panic` lint detects an operation that will cause a
245     /// panic at runtime.
246     ///
247     /// ### Example
248     ///
249     /// ```rust,compile_fail
250     /// # #![allow(unused)]
251     /// let x = 1 / 0;
252     /// ```
253     ///
254     /// {{produces}}
255     ///
256     /// ### Explanation
257     ///
258     /// This lint detects code that is very likely incorrect because it will
259     /// always panic, such as division by zero and out-of-bounds array
260     /// accesses. Consider adjusting your code if this is a bug, or using the
261     /// `panic!` or `unreachable!` macro instead in case the panic is intended.
262     pub UNCONDITIONAL_PANIC,
263     Deny,
264     "operation will cause a panic at runtime"
265 }
266
267 declare_lint! {
268     /// The `const_err` lint detects an erroneous expression while doing
269     /// constant evaluation.
270     ///
271     /// ### Example
272     ///
273     /// ```rust,compile_fail
274     /// #![allow(unconditional_panic)]
275     /// const C: i32 = 1/0;
276     /// ```
277     ///
278     /// {{produces}}
279     ///
280     /// ### Explanation
281     ///
282     /// This lint detects constants that fail to evaluate. Allowing the lint will accept the
283     /// constant declaration, but any use of this constant will still lead to a hard error. This is
284     /// a future incompatibility lint; the plan is to eventually entirely forbid even declaring
285     /// constants that cannot be evaluated.  See [issue #71800] for more details.
286     ///
287     /// [issue #71800]: https://github.com/rust-lang/rust/issues/71800
288     pub CONST_ERR,
289     Deny,
290     "constant evaluation encountered erroneous expression",
291     @future_incompatible = FutureIncompatibleInfo {
292         reference: "issue #71800 <https://github.com/rust-lang/rust/issues/71800>",
293     };
294     report_in_external_macro
295 }
296
297 declare_lint! {
298     /// The `unused_imports` lint detects imports that are never used.
299     ///
300     /// ### Example
301     ///
302     /// ```rust
303     /// use std::collections::HashMap;
304     /// ```
305     ///
306     /// {{produces}}
307     ///
308     /// ### Explanation
309     ///
310     /// Unused imports may signal a mistake or unfinished code, and clutter
311     /// the code, and should be removed. If you intended to re-export the item
312     /// to make it available outside of the module, add a visibility modifier
313     /// like `pub`.
314     pub UNUSED_IMPORTS,
315     Warn,
316     "imports that are never used"
317 }
318
319 declare_lint! {
320     /// The `unused_extern_crates` lint guards against `extern crate` items
321     /// that are never used.
322     ///
323     /// ### Example
324     ///
325     /// ```rust,compile_fail
326     /// #![deny(unused_extern_crates)]
327     /// extern crate proc_macro;
328     /// ```
329     ///
330     /// {{produces}}
331     ///
332     /// ### Explanation
333     ///
334     /// `extern crate` items that are unused have no effect and should be
335     /// removed. Note that there are some cases where specifying an `extern
336     /// crate` is desired for the side effect of ensuring the given crate is
337     /// linked, even though it is not otherwise directly referenced. The lint
338     /// can be silenced by aliasing the crate to an underscore, such as
339     /// `extern crate foo as _`. Also note that it is no longer idiomatic to
340     /// use `extern crate` in the [2018 edition], as extern crates are now
341     /// automatically added in scope.
342     ///
343     /// This lint is "allow" by default because it can be noisy, and produce
344     /// false-positives. If a dependency is being removed from a project, it
345     /// is recommended to remove it from the build configuration (such as
346     /// `Cargo.toml`) to ensure stale build entries aren't left behind.
347     ///
348     /// [2018 edition]: https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-clarity.html#no-more-extern-crate
349     pub UNUSED_EXTERN_CRATES,
350     Allow,
351     "extern crates that are never used"
352 }
353
354 declare_lint! {
355     /// The `unused_crate_dependencies` lint detects crate dependencies that
356     /// are never used.
357     ///
358     /// ### Example
359     ///
360     /// ```rust,ignore (needs extern crate)
361     /// #![deny(unused_crate_dependencies)]
362     /// ```
363     ///
364     /// This will produce:
365     ///
366     /// ```text
367     /// error: external crate `regex` unused in `lint_example`: remove the dependency or add `use regex as _;`
368     ///   |
369     /// note: the lint level is defined here
370     ///  --> src/lib.rs:1:9
371     ///   |
372     /// 1 | #![deny(unused_crate_dependencies)]
373     ///   |         ^^^^^^^^^^^^^^^^^^^^^^^^^
374     /// ```
375     ///
376     /// ### Explanation
377     ///
378     /// After removing the code that uses a dependency, this usually also
379     /// requires removing the dependency from the build configuration.
380     /// However, sometimes that step can be missed, which leads to time wasted
381     /// building dependencies that are no longer used. This lint can be
382     /// enabled to detect dependencies that are never used (more specifically,
383     /// any dependency passed with the `--extern` command-line flag that is
384     /// never referenced via [`use`], [`extern crate`], or in any [path]).
385     ///
386     /// This lint is "allow" by default because it can provide false positives
387     /// depending on how the build system is configured. For example, when
388     /// using Cargo, a "package" consists of multiple crates (such as a
389     /// library and a binary), but the dependencies are defined for the
390     /// package as a whole. If there is a dependency that is only used in the
391     /// binary, but not the library, then the lint will be incorrectly issued
392     /// in the library.
393     ///
394     /// [path]: https://doc.rust-lang.org/reference/paths.html
395     /// [`use`]: https://doc.rust-lang.org/reference/items/use-declarations.html
396     /// [`extern crate`]: https://doc.rust-lang.org/reference/items/extern-crates.html
397     pub UNUSED_CRATE_DEPENDENCIES,
398     Allow,
399     "crate dependencies that are never used",
400     crate_level_only
401 }
402
403 declare_lint! {
404     /// The `unused_qualifications` lint detects unnecessarily qualified
405     /// names.
406     ///
407     /// ### Example
408     ///
409     /// ```rust,compile_fail
410     /// #![deny(unused_qualifications)]
411     /// mod foo {
412     ///     pub fn bar() {}
413     /// }
414     ///
415     /// fn main() {
416     ///     use foo::bar;
417     ///     foo::bar();
418     /// }
419     /// ```
420     ///
421     /// {{produces}}
422     ///
423     /// ### Explanation
424     ///
425     /// If an item from another module is already brought into scope, then
426     /// there is no need to qualify it in this case. You can call `bar()`
427     /// directly, without the `foo::`.
428     ///
429     /// This lint is "allow" by default because it is somewhat pedantic, and
430     /// doesn't indicate an actual problem, but rather a stylistic choice, and
431     /// can be noisy when refactoring or moving around code.
432     pub UNUSED_QUALIFICATIONS,
433     Allow,
434     "detects unnecessarily qualified names"
435 }
436
437 declare_lint! {
438     /// The `unknown_lints` lint detects unrecognized lint attribute.
439     ///
440     /// ### Example
441     ///
442     /// ```rust
443     /// #![allow(not_a_real_lint)]
444     /// ```
445     ///
446     /// {{produces}}
447     ///
448     /// ### Explanation
449     ///
450     /// It is usually a mistake to specify a lint that does not exist. Check
451     /// the spelling, and check the lint listing for the correct name. Also
452     /// consider if you are using an old version of the compiler, and the lint
453     /// is only available in a newer version.
454     pub UNKNOWN_LINTS,
455     Warn,
456     "unrecognized lint attribute"
457 }
458
459 declare_lint! {
460     /// The `unused_variables` lint detects variables which are not used in
461     /// any way.
462     ///
463     /// ### Example
464     ///
465     /// ```rust
466     /// let x = 5;
467     /// ```
468     ///
469     /// {{produces}}
470     ///
471     /// ### Explanation
472     ///
473     /// Unused variables may signal a mistake or unfinished code. To silence
474     /// the warning for the individual variable, prefix it with an underscore
475     /// such as `_x`.
476     pub UNUSED_VARIABLES,
477     Warn,
478     "detect variables which are not used in any way"
479 }
480
481 declare_lint! {
482     /// The `unused_assignments` lint detects assignments that will never be read.
483     ///
484     /// ### Example
485     ///
486     /// ```rust
487     /// let mut x = 5;
488     /// x = 6;
489     /// ```
490     ///
491     /// {{produces}}
492     ///
493     /// ### Explanation
494     ///
495     /// Unused assignments may signal a mistake or unfinished code. If the
496     /// variable is never used after being assigned, then the assignment can
497     /// be removed. Variables with an underscore prefix such as `_x` will not
498     /// trigger this lint.
499     pub UNUSED_ASSIGNMENTS,
500     Warn,
501     "detect assignments that will never be read"
502 }
503
504 declare_lint! {
505     /// The `dead_code` lint detects unused, unexported items.
506     ///
507     /// ### Example
508     ///
509     /// ```rust
510     /// fn foo() {}
511     /// ```
512     ///
513     /// {{produces}}
514     ///
515     /// ### Explanation
516     ///
517     /// Dead code may signal a mistake or unfinished code. To silence the
518     /// warning for individual items, prefix the name with an underscore such
519     /// as `_foo`. If it was intended to expose the item outside of the crate,
520     /// consider adding a visibility modifier like `pub`. Otherwise consider
521     /// removing the unused code.
522     pub DEAD_CODE,
523     Warn,
524     "detect unused, unexported items"
525 }
526
527 declare_lint! {
528     /// The `unused_attributes` lint detects attributes that were not used by
529     /// the compiler.
530     ///
531     /// ### Example
532     ///
533     /// ```rust
534     /// #![ignore]
535     /// ```
536     ///
537     /// {{produces}}
538     ///
539     /// ### Explanation
540     ///
541     /// Unused [attributes] may indicate the attribute is placed in the wrong
542     /// position. Consider removing it, or placing it in the correct position.
543     /// Also consider if you intended to use an _inner attribute_ (with a `!`
544     /// such as `#![allow(unused)]`) which applies to the item the attribute
545     /// is within, or an _outer attribute_ (without a `!` such as
546     /// `#[allow(unused)]`) which applies to the item *following* the
547     /// attribute.
548     ///
549     /// [attributes]: https://doc.rust-lang.org/reference/attributes.html
550     pub UNUSED_ATTRIBUTES,
551     Warn,
552     "detects attributes that were not used by the compiler"
553 }
554
555 declare_lint! {
556     /// The `unreachable_code` lint detects unreachable code paths.
557     ///
558     /// ### Example
559     ///
560     /// ```rust,no_run
561     /// panic!("we never go past here!");
562     ///
563     /// let x = 5;
564     /// ```
565     ///
566     /// {{produces}}
567     ///
568     /// ### Explanation
569     ///
570     /// Unreachable code may signal a mistake or unfinished code. If the code
571     /// is no longer in use, consider removing it.
572     pub UNREACHABLE_CODE,
573     Warn,
574     "detects unreachable code paths",
575     report_in_external_macro
576 }
577
578 declare_lint! {
579     /// The `unreachable_patterns` lint detects unreachable patterns.
580     ///
581     /// ### Example
582     ///
583     /// ```rust
584     /// let x = 5;
585     /// match x {
586     ///     y => (),
587     ///     5 => (),
588     /// }
589     /// ```
590     ///
591     /// {{produces}}
592     ///
593     /// ### Explanation
594     ///
595     /// This usually indicates a mistake in how the patterns are specified or
596     /// ordered. In this example, the `y` pattern will always match, so the
597     /// five is impossible to reach. Remember, match arms match in order, you
598     /// probably wanted to put the `5` case above the `y` case.
599     pub UNREACHABLE_PATTERNS,
600     Warn,
601     "detects unreachable patterns"
602 }
603
604 declare_lint! {
605     /// The `overlapping_range_endpoints` lint detects `match` arms that have [range patterns] that
606     /// overlap on their endpoints.
607     ///
608     /// [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns
609     ///
610     /// ### Example
611     ///
612     /// ```rust
613     /// let x = 123u8;
614     /// match x {
615     ///     0..=100 => { println!("small"); }
616     ///     100..=255 => { println!("large"); }
617     /// }
618     /// ```
619     ///
620     /// {{produces}}
621     ///
622     /// ### Explanation
623     ///
624     /// It is likely a mistake to have range patterns in a match expression that overlap in this
625     /// way. Check that the beginning and end values are what you expect, and keep in mind that
626     /// with `..=` the left and right bounds are inclusive.
627     pub OVERLAPPING_RANGE_ENDPOINTS,
628     Warn,
629     "detects range patterns with overlapping endpoints"
630 }
631
632 declare_lint! {
633     /// The `bindings_with_variant_name` lint detects pattern bindings with
634     /// the same name as one of the matched variants.
635     ///
636     /// ### Example
637     ///
638     /// ```rust
639     /// pub enum Enum {
640     ///     Foo,
641     ///     Bar,
642     /// }
643     ///
644     /// pub fn foo(x: Enum) {
645     ///     match x {
646     ///         Foo => {}
647     ///         Bar => {}
648     ///     }
649     /// }
650     /// ```
651     ///
652     /// {{produces}}
653     ///
654     /// ### Explanation
655     ///
656     /// It is usually a mistake to specify an enum variant name as an
657     /// [identifier pattern]. In the example above, the `match` arms are
658     /// specifying a variable name to bind the value of `x` to. The second arm
659     /// is ignored because the first one matches *all* values. The likely
660     /// intent is that the arm was intended to match on the enum variant.
661     ///
662     /// Two possible solutions are:
663     ///
664     /// * Specify the enum variant using a [path pattern], such as
665     ///   `Enum::Foo`.
666     /// * Bring the enum variants into local scope, such as adding `use
667     ///   Enum::*;` to the beginning of the `foo` function in the example
668     ///   above.
669     ///
670     /// [identifier pattern]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
671     /// [path pattern]: https://doc.rust-lang.org/reference/patterns.html#path-patterns
672     pub BINDINGS_WITH_VARIANT_NAME,
673     Warn,
674     "detects pattern bindings with the same name as one of the matched variants"
675 }
676
677 declare_lint! {
678     /// The `unused_macros` lint detects macros that were not used.
679     ///
680     /// ### Example
681     ///
682     /// ```rust
683     /// macro_rules! unused {
684     ///     () => {};
685     /// }
686     ///
687     /// fn main() {
688     /// }
689     /// ```
690     ///
691     /// {{produces}}
692     ///
693     /// ### Explanation
694     ///
695     /// Unused macros may signal a mistake or unfinished code. To silence the
696     /// warning for the individual macro, prefix the name with an underscore
697     /// such as `_my_macro`. If you intended to export the macro to make it
698     /// available outside of the crate, use the [`macro_export` attribute].
699     ///
700     /// [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
701     pub UNUSED_MACROS,
702     Warn,
703     "detects macros that were not used"
704 }
705
706 declare_lint! {
707     /// The `warnings` lint allows you to change the level of other
708     /// lints which produce warnings.
709     ///
710     /// ### Example
711     ///
712     /// ```rust
713     /// #![deny(warnings)]
714     /// fn foo() {}
715     /// ```
716     ///
717     /// {{produces}}
718     ///
719     /// ### Explanation
720     ///
721     /// The `warnings` lint is a bit special; by changing its level, you
722     /// change every other warning that would produce a warning to whatever
723     /// value you'd like. As such, you won't ever trigger this lint in your
724     /// code directly.
725     pub WARNINGS,
726     Warn,
727     "mass-change the level for lints which produce warnings"
728 }
729
730 declare_lint! {
731     /// The `unused_features` lint detects unused or unknown features found in
732     /// crate-level [`feature` attributes].
733     ///
734     /// [`feature` attributes]: https://doc.rust-lang.org/nightly/unstable-book/
735     ///
736     /// Note: This lint is currently not functional, see [issue #44232] for
737     /// more details.
738     ///
739     /// [issue #44232]: https://github.com/rust-lang/rust/issues/44232
740     pub UNUSED_FEATURES,
741     Warn,
742     "unused features found in crate-level `#[feature]` directives"
743 }
744
745 declare_lint! {
746     /// The `stable_features` lint detects a [`feature` attribute] that
747     /// has since been made stable.
748     ///
749     /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
750     ///
751     /// ### Example
752     ///
753     /// ```rust
754     /// #![feature(test_accepted_feature)]
755     /// fn main() {}
756     /// ```
757     ///
758     /// {{produces}}
759     ///
760     /// ### Explanation
761     ///
762     /// When a feature is stabilized, it is no longer necessary to include a
763     /// `#![feature]` attribute for it. To fix, simply remove the
764     /// `#![feature]` attribute.
765     pub STABLE_FEATURES,
766     Warn,
767     "stable features found in `#[feature]` directive"
768 }
769
770 declare_lint! {
771     /// The `unknown_crate_types` lint detects an unknown crate type found in
772     /// a [`crate_type` attribute].
773     ///
774     /// ### Example
775     ///
776     /// ```rust,compile_fail
777     /// #![crate_type="lol"]
778     /// fn main() {}
779     /// ```
780     ///
781     /// {{produces}}
782     ///
783     /// ### Explanation
784     ///
785     /// An unknown value give to the `crate_type` attribute is almost
786     /// certainly a mistake.
787     ///
788     /// [`crate_type` attribute]: https://doc.rust-lang.org/reference/linkage.html
789     pub UNKNOWN_CRATE_TYPES,
790     Deny,
791     "unknown crate type found in `#[crate_type]` directive",
792     crate_level_only
793 }
794
795 declare_lint! {
796     /// The `trivial_casts` lint detects trivial casts which could be replaced
797     /// with coercion, which may require [type ascription] or a temporary
798     /// variable.
799     ///
800     /// ### Example
801     ///
802     /// ```rust,compile_fail
803     /// #![deny(trivial_casts)]
804     /// let x: &u32 = &42;
805     /// let y = x as *const u32;
806     /// ```
807     ///
808     /// {{produces}}
809     ///
810     /// ### Explanation
811     ///
812     /// A trivial cast is a cast `e as T` where `e` has type `U` and `U` is a
813     /// subtype of `T`. This type of cast is usually unnecessary, as it can be
814     /// usually be inferred.
815     ///
816     /// This lint is "allow" by default because there are situations, such as
817     /// with FFI interfaces or complex type aliases, where it triggers
818     /// incorrectly, or in situations where it will be more difficult to
819     /// clearly express the intent. It may be possible that this will become a
820     /// warning in the future, possibly with [type ascription] providing a
821     /// convenient way to work around the current issues. See [RFC 401] for
822     /// historical context.
823     ///
824     /// [type ascription]: https://github.com/rust-lang/rust/issues/23416
825     /// [RFC 401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
826     pub TRIVIAL_CASTS,
827     Allow,
828     "detects trivial casts which could be removed"
829 }
830
831 declare_lint! {
832     /// The `trivial_numeric_casts` lint detects trivial numeric casts of types
833     /// which could be removed.
834     ///
835     /// ### Example
836     ///
837     /// ```rust,compile_fail
838     /// #![deny(trivial_numeric_casts)]
839     /// let x = 42_i32 as i32;
840     /// ```
841     ///
842     /// {{produces}}
843     ///
844     /// ### Explanation
845     ///
846     /// A trivial numeric cast is a cast of a numeric type to the same numeric
847     /// type. This type of cast is usually unnecessary.
848     ///
849     /// This lint is "allow" by default because there are situations, such as
850     /// with FFI interfaces or complex type aliases, where it triggers
851     /// incorrectly, or in situations where it will be more difficult to
852     /// clearly express the intent. It may be possible that this will become a
853     /// warning in the future, possibly with [type ascription] providing a
854     /// convenient way to work around the current issues. See [RFC 401] for
855     /// historical context.
856     ///
857     /// [type ascription]: https://github.com/rust-lang/rust/issues/23416
858     /// [RFC 401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
859     pub TRIVIAL_NUMERIC_CASTS,
860     Allow,
861     "detects trivial casts of numeric types which could be removed"
862 }
863
864 declare_lint! {
865     /// The `private_in_public` lint detects private items in public
866     /// interfaces not caught by the old implementation.
867     ///
868     /// ### Example
869     ///
870     /// ```rust
871     /// # #![allow(unused)]
872     /// struct SemiPriv;
873     ///
874     /// mod m1 {
875     ///     struct Priv;
876     ///     impl super::SemiPriv {
877     ///         pub fn f(_: Priv) {}
878     ///     }
879     /// }
880     /// # fn main() {}
881     /// ```
882     ///
883     /// {{produces}}
884     ///
885     /// ### Explanation
886     ///
887     /// The visibility rules are intended to prevent exposing private items in
888     /// public interfaces. This is a [future-incompatible] lint to transition
889     /// this to a hard error in the future. See [issue #34537] for more
890     /// details.
891     ///
892     /// [issue #34537]: https://github.com/rust-lang/rust/issues/34537
893     /// [future-incompatible]: ../index.md#future-incompatible-lints
894     pub PRIVATE_IN_PUBLIC,
895     Warn,
896     "detect private items in public interfaces not caught by the old implementation",
897     @future_incompatible = FutureIncompatibleInfo {
898         reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
899     };
900 }
901
902 declare_lint! {
903     /// The `exported_private_dependencies` lint detects private dependencies
904     /// that are exposed in a public interface.
905     ///
906     /// ### Example
907     ///
908     /// ```rust,ignore (needs-dependency)
909     /// pub fn foo() -> Option<some_private_dependency::Thing> {
910     ///     None
911     /// }
912     /// ```
913     ///
914     /// This will produce:
915     ///
916     /// ```text
917     /// warning: type `bar::Thing` from private dependency 'bar' in public interface
918     ///  --> src/lib.rs:3:1
919     ///   |
920     /// 3 | pub fn foo() -> Option<bar::Thing> {
921     ///   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
922     ///   |
923     ///   = note: `#[warn(exported_private_dependencies)]` on by default
924     /// ```
925     ///
926     /// ### Explanation
927     ///
928     /// Dependencies can be marked as "private" to indicate that they are not
929     /// exposed in the public interface of a crate. This can be used by Cargo
930     /// to independently resolve those dependencies because it can assume it
931     /// does not need to unify them with other packages using that same
932     /// dependency. This lint is an indication of a violation of that
933     /// contract.
934     ///
935     /// To fix this, avoid exposing the dependency in your public interface.
936     /// Or, switch the dependency to a public dependency.
937     ///
938     /// Note that support for this is only available on the nightly channel.
939     /// See [RFC 1977] for more details, as well as the [Cargo documentation].
940     ///
941     /// [RFC 1977]: https://github.com/rust-lang/rfcs/blob/master/text/1977-public-private-dependencies.md
942     /// [Cargo documentation]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#public-dependency
943     pub EXPORTED_PRIVATE_DEPENDENCIES,
944     Warn,
945     "public interface leaks type from a private dependency"
946 }
947
948 declare_lint! {
949     /// The `pub_use_of_private_extern_crate` lint detects a specific
950     /// situation of re-exporting a private `extern crate`.
951     ///
952     /// ### Example
953     ///
954     /// ```rust,compile_fail
955     /// extern crate core;
956     /// pub use core as reexported_core;
957     /// ```
958     ///
959     /// {{produces}}
960     ///
961     /// ### Explanation
962     ///
963     /// A public `use` declaration should not be used to publicly re-export a
964     /// private `extern crate`. `pub extern crate` should be used instead.
965     ///
966     /// This was historically allowed, but is not the intended behavior
967     /// according to the visibility rules. This is a [future-incompatible]
968     /// lint to transition this to a hard error in the future. See [issue
969     /// #34537] for more details.
970     ///
971     /// [issue #34537]: https://github.com/rust-lang/rust/issues/34537
972     /// [future-incompatible]: ../index.md#future-incompatible-lints
973     pub PUB_USE_OF_PRIVATE_EXTERN_CRATE,
974     Deny,
975     "detect public re-exports of private extern crates",
976     @future_incompatible = FutureIncompatibleInfo {
977         reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
978     };
979 }
980
981 declare_lint! {
982     /// The `invalid_type_param_default` lint detects type parameter defaults
983     /// erroneously allowed in an invalid location.
984     ///
985     /// ### Example
986     ///
987     /// ```rust,compile_fail
988     /// fn foo<T=i32>(t: T) {}
989     /// ```
990     ///
991     /// {{produces}}
992     ///
993     /// ### Explanation
994     ///
995     /// Default type parameters were only intended to be allowed in certain
996     /// situations, but historically the compiler allowed them everywhere.
997     /// This is a [future-incompatible] lint to transition this to a hard
998     /// error in the future. See [issue #36887] for more details.
999     ///
1000     /// [issue #36887]: https://github.com/rust-lang/rust/issues/36887
1001     /// [future-incompatible]: ../index.md#future-incompatible-lints
1002     pub INVALID_TYPE_PARAM_DEFAULT,
1003     Deny,
1004     "type parameter default erroneously allowed in invalid location",
1005     @future_incompatible = FutureIncompatibleInfo {
1006         reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
1007     };
1008 }
1009
1010 declare_lint! {
1011     /// The `renamed_and_removed_lints` lint detects lints that have been
1012     /// renamed or removed.
1013     ///
1014     /// ### Example
1015     ///
1016     /// ```rust
1017     /// #![deny(raw_pointer_derive)]
1018     /// ```
1019     ///
1020     /// {{produces}}
1021     ///
1022     /// ### Explanation
1023     ///
1024     /// To fix this, either remove the lint or use the new name. This can help
1025     /// avoid confusion about lints that are no longer valid, and help
1026     /// maintain consistency for renamed lints.
1027     pub RENAMED_AND_REMOVED_LINTS,
1028     Warn,
1029     "lints that have been renamed or removed"
1030 }
1031
1032 declare_lint! {
1033     /// The `unaligned_references` lint detects unaligned references to fields
1034     /// of [packed] structs.
1035     ///
1036     /// [packed]: https://doc.rust-lang.org/reference/type-layout.html#the-alignment-modifiers
1037     ///
1038     /// ### Example
1039     ///
1040     /// ```rust,compile_fail
1041     /// #![deny(unaligned_references)]
1042     ///
1043     /// #[repr(packed)]
1044     /// pub struct Foo {
1045     ///     field1: u64,
1046     ///     field2: u8,
1047     /// }
1048     ///
1049     /// fn main() {
1050     ///     unsafe {
1051     ///         let foo = Foo { field1: 0, field2: 0 };
1052     ///         let _ = &foo.field1;
1053     ///         println!("{}", foo.field1); // An implicit `&` is added here, triggering the lint.
1054     ///     }
1055     /// }
1056     /// ```
1057     ///
1058     /// {{produces}}
1059     ///
1060     /// ### Explanation
1061     ///
1062     /// Creating a reference to an insufficiently aligned packed field is [undefined behavior] and
1063     /// should be disallowed. Using an `unsafe` block does not change anything about this. Instead,
1064     /// the code should do a copy of the data in the packed field or use raw pointers and unaligned
1065     /// accesses. See [issue #82523] for more information.
1066     ///
1067     /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
1068     /// [issue #82523]: https://github.com/rust-lang/rust/issues/82523
1069     pub UNALIGNED_REFERENCES,
1070     Warn,
1071     "detects unaligned references to fields of packed structs",
1072     @future_incompatible = FutureIncompatibleInfo {
1073         reference: "issue #82523 <https://github.com/rust-lang/rust/issues/82523>",
1074     };
1075     report_in_external_macro
1076 }
1077
1078 declare_lint! {
1079     /// The `const_item_mutation` lint detects attempts to mutate a `const`
1080     /// item.
1081     ///
1082     /// ### Example
1083     ///
1084     /// ```rust
1085     /// const FOO: [i32; 1] = [0];
1086     ///
1087     /// fn main() {
1088     ///     FOO[0] = 1;
1089     ///     // This will print "[0]".
1090     ///     println!("{:?}", FOO);
1091     /// }
1092     /// ```
1093     ///
1094     /// {{produces}}
1095     ///
1096     /// ### Explanation
1097     ///
1098     /// Trying to directly mutate a `const` item is almost always a mistake.
1099     /// What is happening in the example above is that a temporary copy of the
1100     /// `const` is mutated, but the original `const` is not. Each time you
1101     /// refer to the `const` by name (such as `FOO` in the example above), a
1102     /// separate copy of the value is inlined at that location.
1103     ///
1104     /// This lint checks for writing directly to a field (`FOO.field =
1105     /// some_value`) or array entry (`FOO[0] = val`), or taking a mutable
1106     /// reference to the const item (`&mut FOO`), including through an
1107     /// autoderef (`FOO.some_mut_self_method()`).
1108     ///
1109     /// There are various alternatives depending on what you are trying to
1110     /// accomplish:
1111     ///
1112     /// * First, always reconsider using mutable globals, as they can be
1113     ///   difficult to use correctly, and can make the code more difficult to
1114     ///   use or understand.
1115     /// * If you are trying to perform a one-time initialization of a global:
1116     ///     * If the value can be computed at compile-time, consider using
1117     ///       const-compatible values (see [Constant Evaluation]).
1118     ///     * For more complex single-initialization cases, consider using a
1119     ///       third-party crate, such as [`lazy_static`] or [`once_cell`].
1120     ///     * If you are using the [nightly channel], consider the new
1121     ///       [`lazy`] module in the standard library.
1122     /// * If you truly need a mutable global, consider using a [`static`],
1123     ///   which has a variety of options:
1124     ///   * Simple data types can be directly defined and mutated with an
1125     ///     [`atomic`] type.
1126     ///   * More complex types can be placed in a synchronization primitive
1127     ///     like a [`Mutex`], which can be initialized with one of the options
1128     ///     listed above.
1129     ///   * A [mutable `static`] is a low-level primitive, requiring unsafe.
1130     ///     Typically This should be avoided in preference of something
1131     ///     higher-level like one of the above.
1132     ///
1133     /// [Constant Evaluation]: https://doc.rust-lang.org/reference/const_eval.html
1134     /// [`static`]: https://doc.rust-lang.org/reference/items/static-items.html
1135     /// [mutable `static`]: https://doc.rust-lang.org/reference/items/static-items.html#mutable-statics
1136     /// [`lazy`]: https://doc.rust-lang.org/nightly/std/lazy/index.html
1137     /// [`lazy_static`]: https://crates.io/crates/lazy_static
1138     /// [`once_cell`]: https://crates.io/crates/once_cell
1139     /// [`atomic`]: https://doc.rust-lang.org/std/sync/atomic/index.html
1140     /// [`Mutex`]: https://doc.rust-lang.org/std/sync/struct.Mutex.html
1141     pub CONST_ITEM_MUTATION,
1142     Warn,
1143     "detects attempts to mutate a `const` item",
1144 }
1145
1146 declare_lint! {
1147     /// The `patterns_in_fns_without_body` lint detects `mut` identifier
1148     /// patterns as a parameter in functions without a body.
1149     ///
1150     /// ### Example
1151     ///
1152     /// ```rust,compile_fail
1153     /// trait Trait {
1154     ///     fn foo(mut arg: u8);
1155     /// }
1156     /// ```
1157     ///
1158     /// {{produces}}
1159     ///
1160     /// ### Explanation
1161     ///
1162     /// To fix this, remove `mut` from the parameter in the trait definition;
1163     /// it can be used in the implementation. That is, the following is OK:
1164     ///
1165     /// ```rust
1166     /// trait Trait {
1167     ///     fn foo(arg: u8); // Removed `mut` here
1168     /// }
1169     ///
1170     /// impl Trait for i32 {
1171     ///     fn foo(mut arg: u8) { // `mut` here is OK
1172     ///
1173     ///     }
1174     /// }
1175     /// ```
1176     ///
1177     /// Trait definitions can define functions without a body to specify a
1178     /// function that implementors must define. The parameter names in the
1179     /// body-less functions are only allowed to be `_` or an [identifier] for
1180     /// documentation purposes (only the type is relevant). Previous versions
1181     /// of the compiler erroneously allowed [identifier patterns] with the
1182     /// `mut` keyword, but this was not intended to be allowed. This is a
1183     /// [future-incompatible] lint to transition this to a hard error in the
1184     /// future. See [issue #35203] for more details.
1185     ///
1186     /// [identifier]: https://doc.rust-lang.org/reference/identifiers.html
1187     /// [identifier patterns]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
1188     /// [issue #35203]: https://github.com/rust-lang/rust/issues/35203
1189     /// [future-incompatible]: ../index.md#future-incompatible-lints
1190     pub PATTERNS_IN_FNS_WITHOUT_BODY,
1191     Deny,
1192     "patterns in functions without body were erroneously allowed",
1193     @future_incompatible = FutureIncompatibleInfo {
1194         reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
1195     };
1196 }
1197
1198 declare_lint! {
1199     /// The `missing_fragment_specifier` lint is issued when an unused pattern in a
1200     /// `macro_rules!` macro definition has a meta-variable (e.g. `$e`) that is not
1201     /// followed by a fragment specifier (e.g. `:expr`).
1202     ///
1203     /// This warning can always be fixed by removing the unused pattern in the
1204     /// `macro_rules!` macro definition.
1205     ///
1206     /// ### Example
1207     ///
1208     /// ```rust,compile_fail
1209     /// macro_rules! foo {
1210     ///    () => {};
1211     ///    ($name) => { };
1212     /// }
1213     ///
1214     /// fn main() {
1215     ///    foo!();
1216     /// }
1217     /// ```
1218     ///
1219     /// {{produces}}
1220     ///
1221     /// ### Explanation
1222     ///
1223     /// To fix this, remove the unused pattern from the `macro_rules!` macro definition:
1224     ///
1225     /// ```rust
1226     /// macro_rules! foo {
1227     ///     () => {};
1228     /// }
1229     /// fn main() {
1230     ///     foo!();
1231     /// }
1232     /// ```
1233     pub MISSING_FRAGMENT_SPECIFIER,
1234     Deny,
1235     "detects missing fragment specifiers in unused `macro_rules!` patterns",
1236     @future_incompatible = FutureIncompatibleInfo {
1237         reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
1238     };
1239 }
1240
1241 declare_lint! {
1242     /// The `late_bound_lifetime_arguments` lint detects generic lifetime
1243     /// arguments in path segments with late bound lifetime parameters.
1244     ///
1245     /// ### Example
1246     ///
1247     /// ```rust
1248     /// struct S;
1249     ///
1250     /// impl S {
1251     ///     fn late<'a, 'b>(self, _: &'a u8, _: &'b u8) {}
1252     /// }
1253     ///
1254     /// fn main() {
1255     ///     S.late::<'static>(&0, &0);
1256     /// }
1257     /// ```
1258     ///
1259     /// {{produces}}
1260     ///
1261     /// ### Explanation
1262     ///
1263     /// It is not clear how to provide arguments for early-bound lifetime
1264     /// parameters if they are intermixed with late-bound parameters in the
1265     /// same list. For now, providing any explicit arguments will trigger this
1266     /// lint if late-bound parameters are present, so in the future a solution
1267     /// can be adopted without hitting backward compatibility issues. This is
1268     /// a [future-incompatible] lint to transition this to a hard error in the
1269     /// future. See [issue #42868] for more details, along with a description
1270     /// of the difference between early and late-bound parameters.
1271     ///
1272     /// [issue #42868]: https://github.com/rust-lang/rust/issues/42868
1273     /// [future-incompatible]: ../index.md#future-incompatible-lints
1274     pub LATE_BOUND_LIFETIME_ARGUMENTS,
1275     Warn,
1276     "detects generic lifetime arguments in path segments with late bound lifetime parameters",
1277     @future_incompatible = FutureIncompatibleInfo {
1278         reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
1279     };
1280 }
1281
1282 declare_lint! {
1283     /// The `order_dependent_trait_objects` lint detects a trait coherency
1284     /// violation that would allow creating two trait impls for the same
1285     /// dynamic trait object involving marker traits.
1286     ///
1287     /// ### Example
1288     ///
1289     /// ```rust,compile_fail
1290     /// pub trait Trait {}
1291     ///
1292     /// impl Trait for dyn Send + Sync { }
1293     /// impl Trait for dyn Sync + Send { }
1294     /// ```
1295     ///
1296     /// {{produces}}
1297     ///
1298     /// ### Explanation
1299     ///
1300     /// A previous bug caused the compiler to interpret traits with different
1301     /// orders (such as `Send + Sync` and `Sync + Send`) as distinct types
1302     /// when they were intended to be treated the same. This allowed code to
1303     /// define separate trait implementations when there should be a coherence
1304     /// error. This is a [future-incompatible] lint to transition this to a
1305     /// hard error in the future. See [issue #56484] for more details.
1306     ///
1307     /// [issue #56484]: https://github.com/rust-lang/rust/issues/56484
1308     /// [future-incompatible]: ../index.md#future-incompatible-lints
1309     pub ORDER_DEPENDENT_TRAIT_OBJECTS,
1310     Deny,
1311     "trait-object types were treated as different depending on marker-trait order",
1312     @future_incompatible = FutureIncompatibleInfo {
1313         reference: "issue #56484 <https://github.com/rust-lang/rust/issues/56484>",
1314     };
1315 }
1316
1317 declare_lint! {
1318     /// The `coherence_leak_check` lint detects conflicting implementations of
1319     /// a trait that are only distinguished by the old leak-check code.
1320     ///
1321     /// ### Example
1322     ///
1323     /// ```rust
1324     /// trait SomeTrait { }
1325     /// impl SomeTrait for for<'a> fn(&'a u8) { }
1326     /// impl<'a> SomeTrait for fn(&'a u8) { }
1327     /// ```
1328     ///
1329     /// {{produces}}
1330     ///
1331     /// ### Explanation
1332     ///
1333     /// In the past, the compiler would accept trait implementations for
1334     /// identical functions that differed only in where the lifetime binder
1335     /// appeared. Due to a change in the borrow checker implementation to fix
1336     /// several bugs, this is no longer allowed. However, since this affects
1337     /// existing code, this is a [future-incompatible] lint to transition this
1338     /// to a hard error in the future.
1339     ///
1340     /// Code relying on this pattern should introduce "[newtypes]",
1341     /// like `struct Foo(for<'a> fn(&'a u8))`.
1342     ///
1343     /// See [issue #56105] for more details.
1344     ///
1345     /// [issue #56105]: https://github.com/rust-lang/rust/issues/56105
1346     /// [newtypes]: https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction
1347     /// [future-incompatible]: ../index.md#future-incompatible-lints
1348     pub COHERENCE_LEAK_CHECK,
1349     Warn,
1350     "distinct impls distinguished only by the leak-check code",
1351     @future_incompatible = FutureIncompatibleInfo {
1352         reference: "issue #56105 <https://github.com/rust-lang/rust/issues/56105>",
1353     };
1354 }
1355
1356 declare_lint! {
1357     /// The `deprecated` lint detects use of deprecated items.
1358     ///
1359     /// ### Example
1360     ///
1361     /// ```rust
1362     /// #[deprecated]
1363     /// fn foo() {}
1364     ///
1365     /// fn bar() {
1366     ///     foo();
1367     /// }
1368     /// ```
1369     ///
1370     /// {{produces}}
1371     ///
1372     /// ### Explanation
1373     ///
1374     /// Items may be marked "deprecated" with the [`deprecated` attribute] to
1375     /// indicate that they should no longer be used. Usually the attribute
1376     /// should include a note on what to use instead, or check the
1377     /// documentation.
1378     ///
1379     /// [`deprecated` attribute]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute
1380     pub DEPRECATED,
1381     Warn,
1382     "detects use of deprecated items",
1383     report_in_external_macro
1384 }
1385
1386 declare_lint! {
1387     /// The `unused_unsafe` lint detects unnecessary use of an `unsafe` block.
1388     ///
1389     /// ### Example
1390     ///
1391     /// ```rust
1392     /// unsafe {}
1393     /// ```
1394     ///
1395     /// {{produces}}
1396     ///
1397     /// ### Explanation
1398     ///
1399     /// If nothing within the block requires `unsafe`, then remove the
1400     /// `unsafe` marker because it is not required and may cause confusion.
1401     pub UNUSED_UNSAFE,
1402     Warn,
1403     "unnecessary use of an `unsafe` block"
1404 }
1405
1406 declare_lint! {
1407     /// The `unused_mut` lint detects mut variables which don't need to be
1408     /// mutable.
1409     ///
1410     /// ### Example
1411     ///
1412     /// ```rust
1413     /// let mut x = 5;
1414     /// ```
1415     ///
1416     /// {{produces}}
1417     ///
1418     /// ### Explanation
1419     ///
1420     /// The preferred style is to only mark variables as `mut` if it is
1421     /// required.
1422     pub UNUSED_MUT,
1423     Warn,
1424     "detect mut variables which don't need to be mutable"
1425 }
1426
1427 declare_lint! {
1428     /// The `unconditional_recursion` lint detects functions that cannot
1429     /// return without calling themselves.
1430     ///
1431     /// ### Example
1432     ///
1433     /// ```rust
1434     /// fn foo() {
1435     ///     foo();
1436     /// }
1437     /// ```
1438     ///
1439     /// {{produces}}
1440     ///
1441     /// ### Explanation
1442     ///
1443     /// It is usually a mistake to have a recursive call that does not have
1444     /// some condition to cause it to terminate. If you really intend to have
1445     /// an infinite loop, using a `loop` expression is recommended.
1446     pub UNCONDITIONAL_RECURSION,
1447     Warn,
1448     "functions that cannot return without calling themselves"
1449 }
1450
1451 declare_lint! {
1452     /// The `single_use_lifetimes` lint detects lifetimes that are only used
1453     /// once.
1454     ///
1455     /// ### Example
1456     ///
1457     /// ```rust,compile_fail
1458     /// #![deny(single_use_lifetimes)]
1459     ///
1460     /// fn foo<'a>(x: &'a u32) {}
1461     /// ```
1462     ///
1463     /// {{produces}}
1464     ///
1465     /// ### Explanation
1466     ///
1467     /// Specifying an explicit lifetime like `'a` in a function or `impl`
1468     /// should only be used to link together two things. Otherwise, you should
1469     /// just use `'_` to indicate that the lifetime is not linked to anything,
1470     /// or elide the lifetime altogether if possible.
1471     ///
1472     /// This lint is "allow" by default because it was introduced at a time
1473     /// when `'_` and elided lifetimes were first being introduced, and this
1474     /// lint would be too noisy. Also, there are some known false positives
1475     /// that it produces. See [RFC 2115] for historical context, and [issue
1476     /// #44752] for more details.
1477     ///
1478     /// [RFC 2115]: https://github.com/rust-lang/rfcs/blob/master/text/2115-argument-lifetimes.md
1479     /// [issue #44752]: https://github.com/rust-lang/rust/issues/44752
1480     pub SINGLE_USE_LIFETIMES,
1481     Allow,
1482     "detects lifetime parameters that are only used once"
1483 }
1484
1485 declare_lint! {
1486     /// The `unused_lifetimes` lint detects lifetime parameters that are never
1487     /// used.
1488     ///
1489     /// ### Example
1490     ///
1491     /// ```rust,compile_fail
1492     /// #[deny(unused_lifetimes)]
1493     ///
1494     /// pub fn foo<'a>() {}
1495     /// ```
1496     ///
1497     /// {{produces}}
1498     ///
1499     /// ### Explanation
1500     ///
1501     /// Unused lifetime parameters may signal a mistake or unfinished code.
1502     /// Consider removing the parameter.
1503     pub UNUSED_LIFETIMES,
1504     Allow,
1505     "detects lifetime parameters that are never used"
1506 }
1507
1508 declare_lint! {
1509     /// The `tyvar_behind_raw_pointer` lint detects raw pointer to an
1510     /// inference variable.
1511     ///
1512     /// ### Example
1513     ///
1514     /// ```rust,edition2015
1515     /// // edition 2015
1516     /// let data = std::ptr::null();
1517     /// let _ = &data as *const *const ();
1518     ///
1519     /// if data.is_null() {}
1520     /// ```
1521     ///
1522     /// {{produces}}
1523     ///
1524     /// ### Explanation
1525     ///
1526     /// This kind of inference was previously allowed, but with the future
1527     /// arrival of [arbitrary self types], this can introduce ambiguity. To
1528     /// resolve this, use an explicit type instead of relying on type
1529     /// inference.
1530     ///
1531     /// This is a [future-incompatible] lint to transition this to a hard
1532     /// error in the 2018 edition. See [issue #46906] for more details. This
1533     /// is currently a hard-error on the 2018 edition, and is "warn" by
1534     /// default in the 2015 edition.
1535     ///
1536     /// [arbitrary self types]: https://github.com/rust-lang/rust/issues/44874
1537     /// [issue #46906]: https://github.com/rust-lang/rust/issues/46906
1538     /// [future-incompatible]: ../index.md#future-incompatible-lints
1539     pub TYVAR_BEHIND_RAW_POINTER,
1540     Warn,
1541     "raw pointer to an inference variable",
1542     @future_incompatible = FutureIncompatibleInfo {
1543         reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
1544         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2018),
1545     };
1546 }
1547
1548 declare_lint! {
1549     /// The `elided_lifetimes_in_paths` lint detects the use of hidden
1550     /// lifetime parameters.
1551     ///
1552     /// ### Example
1553     ///
1554     /// ```rust,compile_fail
1555     /// #![deny(elided_lifetimes_in_paths)]
1556     /// struct Foo<'a> {
1557     ///     x: &'a u32
1558     /// }
1559     ///
1560     /// fn foo(x: &Foo) {
1561     /// }
1562     /// ```
1563     ///
1564     /// {{produces}}
1565     ///
1566     /// ### Explanation
1567     ///
1568     /// Elided lifetime parameters can make it difficult to see at a glance
1569     /// that borrowing is occurring. This lint ensures that lifetime
1570     /// parameters are always explicitly stated, even if it is the `'_`
1571     /// [placeholder lifetime].
1572     ///
1573     /// This lint is "allow" by default because it has some known issues, and
1574     /// may require a significant transition for old code.
1575     ///
1576     /// [placeholder lifetime]: https://doc.rust-lang.org/reference/lifetime-elision.html#lifetime-elision-in-functions
1577     pub ELIDED_LIFETIMES_IN_PATHS,
1578     Allow,
1579     "hidden lifetime parameters in types are deprecated",
1580     crate_level_only
1581 }
1582
1583 declare_lint! {
1584     /// The `bare_trait_objects` lint suggests using `dyn Trait` for trait
1585     /// objects.
1586     ///
1587     /// ### Example
1588     ///
1589     /// ```rust
1590     /// trait Trait { }
1591     ///
1592     /// fn takes_trait_object(_: Box<Trait>) {
1593     /// }
1594     /// ```
1595     ///
1596     /// {{produces}}
1597     ///
1598     /// ### Explanation
1599     ///
1600     /// Without the `dyn` indicator, it can be ambiguous or confusing when
1601     /// reading code as to whether or not you are looking at a trait object.
1602     /// The `dyn` keyword makes it explicit, and adds a symmetry to contrast
1603     /// with [`impl Trait`].
1604     ///
1605     /// [`impl Trait`]: https://doc.rust-lang.org/book/ch10-02-traits.html#traits-as-parameters
1606     pub BARE_TRAIT_OBJECTS,
1607     Warn,
1608     "suggest using `dyn Trait` for trait objects",
1609     @future_incompatible = FutureIncompatibleInfo {
1610         reference: "issue #80165 <https://github.com/rust-lang/rust/issues/80165>",
1611         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2021),
1612     };
1613 }
1614
1615 declare_lint! {
1616     /// The `absolute_paths_not_starting_with_crate` lint detects fully
1617     /// qualified paths that start with a module name instead of `crate`,
1618     /// `self`, or an extern crate name
1619     ///
1620     /// ### Example
1621     ///
1622     /// ```rust,edition2015,compile_fail
1623     /// #![deny(absolute_paths_not_starting_with_crate)]
1624     ///
1625     /// mod foo {
1626     ///     pub fn bar() {}
1627     /// }
1628     ///
1629     /// fn main() {
1630     ///     ::foo::bar();
1631     /// }
1632     /// ```
1633     ///
1634     /// {{produces}}
1635     ///
1636     /// ### Explanation
1637     ///
1638     /// Rust [editions] allow the language to evolve without breaking
1639     /// backwards compatibility. This lint catches code that uses absolute
1640     /// paths in the style of the 2015 edition. In the 2015 edition, absolute
1641     /// paths (those starting with `::`) refer to either the crate root or an
1642     /// external crate. In the 2018 edition it was changed so that they only
1643     /// refer to external crates. The path prefix `crate::` should be used
1644     /// instead to reference items from the crate root.
1645     ///
1646     /// If you switch the compiler from the 2015 to 2018 edition without
1647     /// updating the code, then it will fail to compile if the old style paths
1648     /// are used. You can manually change the paths to use the `crate::`
1649     /// prefix to transition to the 2018 edition.
1650     ///
1651     /// This lint solves the problem automatically. It is "allow" by default
1652     /// because the code is perfectly valid in the 2015 edition. The [`cargo
1653     /// fix`] tool with the `--edition` flag will switch this lint to "warn"
1654     /// and automatically apply the suggested fix from the compiler. This
1655     /// provides a completely automated way to update old code to the 2018
1656     /// edition.
1657     ///
1658     /// [editions]: https://doc.rust-lang.org/edition-guide/
1659     /// [`cargo fix`]: https://doc.rust-lang.org/cargo/commands/cargo-fix.html
1660     pub ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
1661     Allow,
1662     "fully qualified paths that start with a module name \
1663      instead of `crate`, `self`, or an extern crate name",
1664      @future_incompatible = FutureIncompatibleInfo {
1665         reference: "issue #53130 <https://github.com/rust-lang/rust/issues/53130>",
1666         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2018),
1667      };
1668 }
1669
1670 declare_lint! {
1671     /// The `illegal_floating_point_literal_pattern` lint detects
1672     /// floating-point literals used in patterns.
1673     ///
1674     /// ### Example
1675     ///
1676     /// ```rust
1677     /// let x = 42.0;
1678     ///
1679     /// match x {
1680     ///     5.0 => {}
1681     ///     _ => {}
1682     /// }
1683     /// ```
1684     ///
1685     /// {{produces}}
1686     ///
1687     /// ### Explanation
1688     ///
1689     /// Previous versions of the compiler accepted floating-point literals in
1690     /// patterns, but it was later determined this was a mistake. The
1691     /// semantics of comparing floating-point values may not be clear in a
1692     /// pattern when contrasted with "structural equality". Typically you can
1693     /// work around this by using a [match guard], such as:
1694     ///
1695     /// ```rust
1696     /// # let x = 42.0;
1697     ///
1698     /// match x {
1699     ///     y if y == 5.0 => {}
1700     ///     _ => {}
1701     /// }
1702     /// ```
1703     ///
1704     /// This is a [future-incompatible] lint to transition this to a hard
1705     /// error in the future. See [issue #41620] for more details.
1706     ///
1707     /// [issue #41620]: https://github.com/rust-lang/rust/issues/41620
1708     /// [match guard]: https://doc.rust-lang.org/reference/expressions/match-expr.html#match-guards
1709     /// [future-incompatible]: ../index.md#future-incompatible-lints
1710     pub ILLEGAL_FLOATING_POINT_LITERAL_PATTERN,
1711     Warn,
1712     "floating-point literals cannot be used in patterns",
1713     @future_incompatible = FutureIncompatibleInfo {
1714         reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
1715     };
1716 }
1717
1718 declare_lint! {
1719     /// The `unstable_name_collisions` lint detects that you have used a name
1720     /// that the standard library plans to add in the future.
1721     ///
1722     /// ### Example
1723     ///
1724     /// ```rust
1725     /// trait MyIterator : Iterator {
1726     ///     // is_sorted is an unstable method that already exists on the Iterator trait
1727     ///     fn is_sorted(self) -> bool where Self: Sized {true}
1728     /// }
1729     ///
1730     /// impl<T: ?Sized> MyIterator for T where T: Iterator { }
1731     ///
1732     /// let x = vec![1, 2, 3];
1733     /// let _ = x.iter().is_sorted();
1734     /// ```
1735     ///
1736     /// {{produces}}
1737     ///
1738     /// ### Explanation
1739     ///
1740     /// When new methods are added to traits in the standard library, they are
1741     /// usually added in an "unstable" form which is only available on the
1742     /// [nightly channel] with a [`feature` attribute]. If there is any
1743     /// pre-existing code which extends a trait to have a method with the same
1744     /// name, then the names will collide. In the future, when the method is
1745     /// stabilized, this will cause an error due to the ambiguity. This lint
1746     /// is an early-warning to let you know that there may be a collision in
1747     /// the future. This can be avoided by adding type annotations to
1748     /// disambiguate which trait method you intend to call, such as
1749     /// `MyIterator::is_sorted(my_iter)` or renaming or removing the method.
1750     ///
1751     /// [nightly channel]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
1752     /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
1753     pub UNSTABLE_NAME_COLLISIONS,
1754     Warn,
1755     "detects name collision with an existing but unstable method",
1756     @future_incompatible = FutureIncompatibleInfo {
1757         reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
1758         // Note: this item represents future incompatibility of all unstable functions in the
1759         //       standard library, and thus should never be removed or changed to an error.
1760     };
1761 }
1762
1763 declare_lint! {
1764     /// The `irrefutable_let_patterns` lint detects [irrefutable patterns]
1765     /// in [`if let`]s, [`while let`]s, and `if let` guards.
1766     ///
1767     /// ### Example
1768     ///
1769     /// ```
1770     /// if let _ = 123 {
1771     ///     println!("always runs!");
1772     /// }
1773     /// ```
1774     ///
1775     /// {{produces}}
1776     ///
1777     /// ### Explanation
1778     ///
1779     /// There usually isn't a reason to have an irrefutable pattern in an
1780     /// `if let` or `while let` statement, because the pattern will always match
1781     /// successfully. A [`let`] or [`loop`] statement will suffice. However,
1782     /// when generating code with a macro, forbidding irrefutable patterns
1783     /// would require awkward workarounds in situations where the macro
1784     /// doesn't know if the pattern is refutable or not. This lint allows
1785     /// macros to accept this form, while alerting for a possibly incorrect
1786     /// use in normal code.
1787     ///
1788     /// See [RFC 2086] for more details.
1789     ///
1790     /// [irrefutable patterns]: https://doc.rust-lang.org/reference/patterns.html#refutability
1791     /// [`if let`]: https://doc.rust-lang.org/reference/expressions/if-expr.html#if-let-expressions
1792     /// [`while let`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#predicate-pattern-loops
1793     /// [`let`]: https://doc.rust-lang.org/reference/statements.html#let-statements
1794     /// [`loop`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#infinite-loops
1795     /// [RFC 2086]: https://github.com/rust-lang/rfcs/blob/master/text/2086-allow-if-let-irrefutables.md
1796     pub IRREFUTABLE_LET_PATTERNS,
1797     Warn,
1798     "detects irrefutable patterns in `if let` and `while let` statements"
1799 }
1800
1801 declare_lint! {
1802     /// The `unused_labels` lint detects [labels] that are never used.
1803     ///
1804     /// [labels]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#loop-labels
1805     ///
1806     /// ### Example
1807     ///
1808     /// ```rust,no_run
1809     /// 'unused_label: loop {}
1810     /// ```
1811     ///
1812     /// {{produces}}
1813     ///
1814     /// ### Explanation
1815     ///
1816     /// Unused labels may signal a mistake or unfinished code. To silence the
1817     /// warning for the individual label, prefix it with an underscore such as
1818     /// `'_my_label:`.
1819     pub UNUSED_LABELS,
1820     Warn,
1821     "detects labels that are never used"
1822 }
1823
1824 declare_lint! {
1825     /// The `where_clauses_object_safety` lint detects for [object safety] of
1826     /// [where clauses].
1827     ///
1828     /// [object safety]: https://doc.rust-lang.org/reference/items/traits.html#object-safety
1829     /// [where clauses]: https://doc.rust-lang.org/reference/items/generics.html#where-clauses
1830     ///
1831     /// ### Example
1832     ///
1833     /// ```rust,no_run
1834     /// trait Trait {}
1835     ///
1836     /// trait X { fn foo(&self) where Self: Trait; }
1837     ///
1838     /// impl X for () { fn foo(&self) {} }
1839     ///
1840     /// impl Trait for dyn X {}
1841     ///
1842     /// // Segfault at opt-level 0, SIGILL otherwise.
1843     /// pub fn main() { <dyn X as X>::foo(&()); }
1844     /// ```
1845     ///
1846     /// {{produces}}
1847     ///
1848     /// ### Explanation
1849     ///
1850     /// The compiler previously allowed these object-unsafe bounds, which was
1851     /// incorrect. This is a [future-incompatible] lint to transition this to
1852     /// a hard error in the future. See [issue #51443] for more details.
1853     ///
1854     /// [issue #51443]: https://github.com/rust-lang/rust/issues/51443
1855     /// [future-incompatible]: ../index.md#future-incompatible-lints
1856     pub WHERE_CLAUSES_OBJECT_SAFETY,
1857     Warn,
1858     "checks the object safety of where clauses",
1859     @future_incompatible = FutureIncompatibleInfo {
1860         reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
1861     };
1862 }
1863
1864 declare_lint! {
1865     /// The `proc_macro_derive_resolution_fallback` lint detects proc macro
1866     /// derives using inaccessible names from parent modules.
1867     ///
1868     /// ### Example
1869     ///
1870     /// ```rust,ignore (proc-macro)
1871     /// // foo.rs
1872     /// #![crate_type = "proc-macro"]
1873     ///
1874     /// extern crate proc_macro;
1875     ///
1876     /// use proc_macro::*;
1877     ///
1878     /// #[proc_macro_derive(Foo)]
1879     /// pub fn foo1(a: TokenStream) -> TokenStream {
1880     ///     drop(a);
1881     ///     "mod __bar { static mut BAR: Option<Something> = None; }".parse().unwrap()
1882     /// }
1883     /// ```
1884     ///
1885     /// ```rust,ignore (needs-dependency)
1886     /// // bar.rs
1887     /// #[macro_use]
1888     /// extern crate foo;
1889     ///
1890     /// struct Something;
1891     ///
1892     /// #[derive(Foo)]
1893     /// struct Another;
1894     ///
1895     /// fn main() {}
1896     /// ```
1897     ///
1898     /// This will produce:
1899     ///
1900     /// ```text
1901     /// warning: cannot find type `Something` in this scope
1902     ///  --> src/main.rs:8:10
1903     ///   |
1904     /// 8 | #[derive(Foo)]
1905     ///   |          ^^^ names from parent modules are not accessible without an explicit import
1906     ///   |
1907     ///   = note: `#[warn(proc_macro_derive_resolution_fallback)]` on by default
1908     ///   = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
1909     ///   = note: for more information, see issue #50504 <https://github.com/rust-lang/rust/issues/50504>
1910     /// ```
1911     ///
1912     /// ### Explanation
1913     ///
1914     /// If a proc-macro generates a module, the compiler unintentionally
1915     /// allowed items in that module to refer to items in the crate root
1916     /// without importing them. This is a [future-incompatible] lint to
1917     /// transition this to a hard error in the future. See [issue #50504] for
1918     /// more details.
1919     ///
1920     /// [issue #50504]: https://github.com/rust-lang/rust/issues/50504
1921     /// [future-incompatible]: ../index.md#future-incompatible-lints
1922     pub PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
1923     Warn,
1924     "detects proc macro derives using inaccessible names from parent modules",
1925     @future_incompatible = FutureIncompatibleInfo {
1926         reference: "issue #83583 <https://github.com/rust-lang/rust/issues/83583>",
1927     };
1928 }
1929
1930 declare_lint! {
1931     /// The `macro_use_extern_crate` lint detects the use of the
1932     /// [`macro_use` attribute].
1933     ///
1934     /// ### Example
1935     ///
1936     /// ```rust,ignore (needs extern crate)
1937     /// #![deny(macro_use_extern_crate)]
1938     ///
1939     /// #[macro_use]
1940     /// extern crate serde_json;
1941     ///
1942     /// fn main() {
1943     ///     let _ = json!{{}};
1944     /// }
1945     /// ```
1946     ///
1947     /// This will produce:
1948     ///
1949     /// ```text
1950     /// error: deprecated `#[macro_use]` attribute used to import macros should be replaced at use sites with a `use` item to import the macro instead
1951     ///  --> src/main.rs:3:1
1952     ///   |
1953     /// 3 | #[macro_use]
1954     ///   | ^^^^^^^^^^^^
1955     ///   |
1956     /// note: the lint level is defined here
1957     ///  --> src/main.rs:1:9
1958     ///   |
1959     /// 1 | #![deny(macro_use_extern_crate)]
1960     ///   |         ^^^^^^^^^^^^^^^^^^^^^^
1961     /// ```
1962     ///
1963     /// ### Explanation
1964     ///
1965     /// The [`macro_use` attribute] on an [`extern crate`] item causes
1966     /// macros in that external crate to be brought into the prelude of the
1967     /// crate, making the macros in scope everywhere. As part of the efforts
1968     /// to simplify handling of dependencies in the [2018 edition], the use of
1969     /// `extern crate` is being phased out. To bring macros from extern crates
1970     /// into scope, it is recommended to use a [`use` import].
1971     ///
1972     /// This lint is "allow" by default because this is a stylistic choice
1973     /// that has not been settled, see [issue #52043] for more information.
1974     ///
1975     /// [`macro_use` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#the-macro_use-attribute
1976     /// [`use` import]: https://doc.rust-lang.org/reference/items/use-declarations.html
1977     /// [issue #52043]: https://github.com/rust-lang/rust/issues/52043
1978     pub MACRO_USE_EXTERN_CRATE,
1979     Allow,
1980     "the `#[macro_use]` attribute is now deprecated in favor of using macros \
1981      via the module system"
1982 }
1983
1984 declare_lint! {
1985     /// The `macro_expanded_macro_exports_accessed_by_absolute_paths` lint
1986     /// detects macro-expanded [`macro_export`] macros from the current crate
1987     /// that cannot be referred to by absolute paths.
1988     ///
1989     /// [`macro_export`]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
1990     ///
1991     /// ### Example
1992     ///
1993     /// ```rust,compile_fail
1994     /// macro_rules! define_exported {
1995     ///     () => {
1996     ///         #[macro_export]
1997     ///         macro_rules! exported {
1998     ///             () => {};
1999     ///         }
2000     ///     };
2001     /// }
2002     ///
2003     /// define_exported!();
2004     ///
2005     /// fn main() {
2006     ///     crate::exported!();
2007     /// }
2008     /// ```
2009     ///
2010     /// {{produces}}
2011     ///
2012     /// ### Explanation
2013     ///
2014     /// The intent is that all macros marked with the `#[macro_export]`
2015     /// attribute are made available in the root of the crate. However, when a
2016     /// `macro_rules!` definition is generated by another macro, the macro
2017     /// expansion is unable to uphold this rule. This is a
2018     /// [future-incompatible] lint to transition this to a hard error in the
2019     /// future. See [issue #53495] for more details.
2020     ///
2021     /// [issue #53495]: https://github.com/rust-lang/rust/issues/53495
2022     /// [future-incompatible]: ../index.md#future-incompatible-lints
2023     pub MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2024     Deny,
2025     "macro-expanded `macro_export` macros from the current crate \
2026      cannot be referred to by absolute paths",
2027     @future_incompatible = FutureIncompatibleInfo {
2028         reference: "issue #52234 <https://github.com/rust-lang/rust/issues/52234>",
2029     };
2030     crate_level_only
2031 }
2032
2033 declare_lint! {
2034     /// The `explicit_outlives_requirements` lint detects unnecessary
2035     /// lifetime bounds that can be inferred.
2036     ///
2037     /// ### Example
2038     ///
2039     /// ```rust,compile_fail
2040     /// # #![allow(unused)]
2041     /// #![deny(explicit_outlives_requirements)]
2042     ///
2043     /// struct SharedRef<'a, T>
2044     /// where
2045     ///     T: 'a,
2046     /// {
2047     ///     data: &'a T,
2048     /// }
2049     /// ```
2050     ///
2051     /// {{produces}}
2052     ///
2053     /// ### Explanation
2054     ///
2055     /// If a `struct` contains a reference, such as `&'a T`, the compiler
2056     /// requires that `T` outlives the lifetime `'a`. This historically
2057     /// required writing an explicit lifetime bound to indicate this
2058     /// requirement. However, this can be overly explicit, causing clutter and
2059     /// unnecessary complexity. The language was changed to automatically
2060     /// infer the bound if it is not specified. Specifically, if the struct
2061     /// contains a reference, directly or indirectly, to `T` with lifetime
2062     /// `'x`, then it will infer that `T: 'x` is a requirement.
2063     ///
2064     /// This lint is "allow" by default because it can be noisy for existing
2065     /// code that already had these requirements. This is a stylistic choice,
2066     /// as it is still valid to explicitly state the bound. It also has some
2067     /// false positives that can cause confusion.
2068     ///
2069     /// See [RFC 2093] for more details.
2070     ///
2071     /// [RFC 2093]: https://github.com/rust-lang/rfcs/blob/master/text/2093-infer-outlives.md
2072     pub EXPLICIT_OUTLIVES_REQUIREMENTS,
2073     Allow,
2074     "outlives requirements can be inferred"
2075 }
2076
2077 declare_lint! {
2078     /// The `indirect_structural_match` lint detects a `const` in a pattern
2079     /// that manually implements [`PartialEq`] and [`Eq`].
2080     ///
2081     /// [`PartialEq`]: https://doc.rust-lang.org/std/cmp/trait.PartialEq.html
2082     /// [`Eq`]: https://doc.rust-lang.org/std/cmp/trait.Eq.html
2083     ///
2084     /// ### Example
2085     ///
2086     /// ```rust,compile_fail
2087     /// #![deny(indirect_structural_match)]
2088     ///
2089     /// struct NoDerive(i32);
2090     /// impl PartialEq for NoDerive { fn eq(&self, _: &Self) -> bool { false } }
2091     /// impl Eq for NoDerive { }
2092     /// #[derive(PartialEq, Eq)]
2093     /// struct WrapParam<T>(T);
2094     /// const WRAP_INDIRECT_PARAM: & &WrapParam<NoDerive> = & &WrapParam(NoDerive(0));
2095     /// fn main() {
2096     ///     match WRAP_INDIRECT_PARAM {
2097     ///         WRAP_INDIRECT_PARAM => { }
2098     ///         _ => { }
2099     ///     }
2100     /// }
2101     /// ```
2102     ///
2103     /// {{produces}}
2104     ///
2105     /// ### Explanation
2106     ///
2107     /// The compiler unintentionally accepted this form in the past. This is a
2108     /// [future-incompatible] lint to transition this to a hard error in the
2109     /// future. See [issue #62411] for a complete description of the problem,
2110     /// and some possible solutions.
2111     ///
2112     /// [issue #62411]: https://github.com/rust-lang/rust/issues/62411
2113     /// [future-incompatible]: ../index.md#future-incompatible-lints
2114     pub INDIRECT_STRUCTURAL_MATCH,
2115     Warn,
2116     "constant used in pattern contains value of non-structural-match type in a field or a variant",
2117     @future_incompatible = FutureIncompatibleInfo {
2118         reference: "issue #62411 <https://github.com/rust-lang/rust/issues/62411>",
2119     };
2120 }
2121
2122 declare_lint! {
2123     /// The `deprecated_in_future` lint is internal to rustc and should not be
2124     /// used by user code.
2125     ///
2126     /// This lint is only enabled in the standard library. It works with the
2127     /// use of `#[rustc_deprecated]` with a `since` field of a version in the
2128     /// future. This allows something to be marked as deprecated in a future
2129     /// version, and then this lint will ensure that the item is no longer
2130     /// used in the standard library. See the [stability documentation] for
2131     /// more details.
2132     ///
2133     /// [stability documentation]: https://rustc-dev-guide.rust-lang.org/stability.html#rustc_deprecated
2134     pub DEPRECATED_IN_FUTURE,
2135     Allow,
2136     "detects use of items that will be deprecated in a future version",
2137     report_in_external_macro
2138 }
2139
2140 declare_lint! {
2141     /// The `pointer_structural_match` lint detects pointers used in patterns whose behaviour
2142     /// cannot be relied upon across compiler versions and optimization levels.
2143     ///
2144     /// ### Example
2145     ///
2146     /// ```rust,compile_fail
2147     /// #![deny(pointer_structural_match)]
2148     /// fn foo(a: usize, b: usize) -> usize { a + b }
2149     /// const FOO: fn(usize, usize) -> usize = foo;
2150     /// fn main() {
2151     ///     match FOO {
2152     ///         FOO => {},
2153     ///         _ => {},
2154     ///     }
2155     /// }
2156     /// ```
2157     ///
2158     /// {{produces}}
2159     ///
2160     /// ### Explanation
2161     ///
2162     /// Previous versions of Rust allowed function pointers and wide raw pointers in patterns.
2163     /// While these work in many cases as expected by users, it is possible that due to
2164     /// optimizations pointers are "not equal to themselves" or pointers to different functions
2165     /// compare as equal during runtime. This is because LLVM optimizations can deduplicate
2166     /// functions if their bodies are the same, thus also making pointers to these functions point
2167     /// to the same location. Additionally functions may get duplicated if they are instantiated
2168     /// in different crates and not deduplicated again via LTO.
2169     pub POINTER_STRUCTURAL_MATCH,
2170     Allow,
2171     "pointers are not structural-match",
2172     @future_incompatible = FutureIncompatibleInfo {
2173         reference: "issue #62411 <https://github.com/rust-lang/rust/issues/70861>",
2174     };
2175 }
2176
2177 declare_lint! {
2178     /// The `nontrivial_structural_match` lint detects constants that are used in patterns,
2179     /// whose type is not structural-match and whose initializer body actually uses values
2180     /// that are not structural-match. So `Option<NotStruturalMatch>` is ok if the constant
2181     /// is just `None`.
2182     ///
2183     /// ### Example
2184     ///
2185     /// ```rust,compile_fail
2186     /// #![deny(nontrivial_structural_match)]
2187     ///
2188     /// #[derive(Copy, Clone, Debug)]
2189     /// struct NoDerive(u32);
2190     /// impl PartialEq for NoDerive { fn eq(&self, _: &Self) -> bool { false } }
2191     /// impl Eq for NoDerive { }
2192     /// fn main() {
2193     ///     const INDEX: Option<NoDerive> = [None, Some(NoDerive(10))][0];
2194     ///     match None { Some(_) => panic!("whoops"), INDEX => dbg!(INDEX), };
2195     /// }
2196     /// ```
2197     ///
2198     /// {{produces}}
2199     ///
2200     /// ### Explanation
2201     ///
2202     /// Previous versions of Rust accepted constants in patterns, even if those constants's types
2203     /// did not have `PartialEq` derived. Thus the compiler falls back to runtime execution of
2204     /// `PartialEq`, which can report that two constants are not equal even if they are
2205     /// bit-equivalent.
2206     pub NONTRIVIAL_STRUCTURAL_MATCH,
2207     Warn,
2208     "constant used in pattern of non-structural-match type and the constant's initializer \
2209     expression contains values of non-structural-match types",
2210     @future_incompatible = FutureIncompatibleInfo {
2211         reference: "issue #73448 <https://github.com/rust-lang/rust/issues/73448>",
2212     };
2213 }
2214
2215 declare_lint! {
2216     /// The `ambiguous_associated_items` lint detects ambiguity between
2217     /// [associated items] and [enum variants].
2218     ///
2219     /// [associated items]: https://doc.rust-lang.org/reference/items/associated-items.html
2220     /// [enum variants]: https://doc.rust-lang.org/reference/items/enumerations.html
2221     ///
2222     /// ### Example
2223     ///
2224     /// ```rust,compile_fail
2225     /// enum E {
2226     ///     V
2227     /// }
2228     ///
2229     /// trait Tr {
2230     ///     type V;
2231     ///     fn foo() -> Self::V;
2232     /// }
2233     ///
2234     /// impl Tr for E {
2235     ///     type V = u8;
2236     ///     // `Self::V` is ambiguous because it may refer to the associated type or
2237     ///     // the enum variant.
2238     ///     fn foo() -> Self::V { 0 }
2239     /// }
2240     /// ```
2241     ///
2242     /// {{produces}}
2243     ///
2244     /// ### Explanation
2245     ///
2246     /// Previous versions of Rust did not allow accessing enum variants
2247     /// through [type aliases]. When this ability was added (see [RFC 2338]), this
2248     /// introduced some situations where it can be ambiguous what a type
2249     /// was referring to.
2250     ///
2251     /// To fix this ambiguity, you should use a [qualified path] to explicitly
2252     /// state which type to use. For example, in the above example the
2253     /// function can be written as `fn f() -> <Self as Tr>::V { 0 }` to
2254     /// specifically refer to the associated type.
2255     ///
2256     /// This is a [future-incompatible] lint to transition this to a hard
2257     /// error in the future. See [issue #57644] for more details.
2258     ///
2259     /// [issue #57644]: https://github.com/rust-lang/rust/issues/57644
2260     /// [type aliases]: https://doc.rust-lang.org/reference/items/type-aliases.html#type-aliases
2261     /// [RFC 2338]: https://github.com/rust-lang/rfcs/blob/master/text/2338-type-alias-enum-variants.md
2262     /// [qualified path]: https://doc.rust-lang.org/reference/paths.html#qualified-paths
2263     /// [future-incompatible]: ../index.md#future-incompatible-lints
2264     pub AMBIGUOUS_ASSOCIATED_ITEMS,
2265     Deny,
2266     "ambiguous associated items",
2267     @future_incompatible = FutureIncompatibleInfo {
2268         reference: "issue #57644 <https://github.com/rust-lang/rust/issues/57644>",
2269     };
2270 }
2271
2272 declare_lint! {
2273     /// The `mutable_borrow_reservation_conflict` lint detects the reservation
2274     /// of a two-phased borrow that conflicts with other shared borrows.
2275     ///
2276     /// ### Example
2277     ///
2278     /// ```rust
2279     /// let mut v = vec![0, 1, 2];
2280     /// let shared = &v;
2281     /// v.push(shared.len());
2282     /// ```
2283     ///
2284     /// {{produces}}
2285     ///
2286     /// ### Explanation
2287     ///
2288     /// This is a [future-incompatible] lint to transition this to a hard error
2289     /// in the future. See [issue #59159] for a complete description of the
2290     /// problem, and some possible solutions.
2291     ///
2292     /// [issue #59159]: https://github.com/rust-lang/rust/issues/59159
2293     /// [future-incompatible]: ../index.md#future-incompatible-lints
2294     pub MUTABLE_BORROW_RESERVATION_CONFLICT,
2295     Warn,
2296     "reservation of a two-phased borrow conflicts with other shared borrows",
2297     @future_incompatible = FutureIncompatibleInfo {
2298         reference: "issue #59159 <https://github.com/rust-lang/rust/issues/59159>",
2299     };
2300 }
2301
2302 declare_lint! {
2303     /// The `soft_unstable` lint detects unstable features that were
2304     /// unintentionally allowed on stable.
2305     ///
2306     /// ### Example
2307     ///
2308     /// ```rust,compile_fail
2309     /// #[cfg(test)]
2310     /// extern crate test;
2311     ///
2312     /// #[bench]
2313     /// fn name(b: &mut test::Bencher) {
2314     ///     b.iter(|| 123)
2315     /// }
2316     /// ```
2317     ///
2318     /// {{produces}}
2319     ///
2320     /// ### Explanation
2321     ///
2322     /// The [`bench` attribute] was accidentally allowed to be specified on
2323     /// the [stable release channel]. Turning this to a hard error would have
2324     /// broken some projects. This lint allows those projects to continue to
2325     /// build correctly when [`--cap-lints`] is used, but otherwise signal an
2326     /// error that `#[bench]` should not be used on the stable channel. This
2327     /// is a [future-incompatible] lint to transition this to a hard error in
2328     /// the future. See [issue #64266] for more details.
2329     ///
2330     /// [issue #64266]: https://github.com/rust-lang/rust/issues/64266
2331     /// [`bench` attribute]: https://doc.rust-lang.org/nightly/unstable-book/library-features/test.html
2332     /// [stable release channel]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
2333     /// [`--cap-lints`]: https://doc.rust-lang.org/rustc/lints/levels.html#capping-lints
2334     /// [future-incompatible]: ../index.md#future-incompatible-lints
2335     pub SOFT_UNSTABLE,
2336     Deny,
2337     "a feature gate that doesn't break dependent crates",
2338     @future_incompatible = FutureIncompatibleInfo {
2339         reference: "issue #64266 <https://github.com/rust-lang/rust/issues/64266>",
2340     };
2341 }
2342
2343 declare_lint! {
2344     /// The `inline_no_sanitize` lint detects incompatible use of
2345     /// [`#[inline(always)]`][inline] and [`#[no_sanitize(...)]`][no_sanitize].
2346     ///
2347     /// [inline]: https://doc.rust-lang.org/reference/attributes/codegen.html#the-inline-attribute
2348     /// [no_sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html
2349     ///
2350     /// ### Example
2351     ///
2352     /// ```rust
2353     /// #![feature(no_sanitize)]
2354     ///
2355     /// #[inline(always)]
2356     /// #[no_sanitize(address)]
2357     /// fn x() {}
2358     ///
2359     /// fn main() {
2360     ///     x()
2361     /// }
2362     /// ```
2363     ///
2364     /// {{produces}}
2365     ///
2366     /// ### Explanation
2367     ///
2368     /// The use of the [`#[inline(always)]`][inline] attribute prevents the
2369     /// the [`#[no_sanitize(...)]`][no_sanitize] attribute from working.
2370     /// Consider temporarily removing `inline` attribute.
2371     pub INLINE_NO_SANITIZE,
2372     Warn,
2373     "detects incompatible use of `#[inline(always)]` and `#[no_sanitize(...)]`",
2374 }
2375
2376 declare_lint! {
2377     /// The `asm_sub_register` lint detects using only a subset of a register
2378     /// for inline asm inputs.
2379     ///
2380     /// ### Example
2381     ///
2382     /// ```rust,ignore (fails on system llvm)
2383     /// #![feature(asm)]
2384     ///
2385     /// fn main() {
2386     ///     #[cfg(target_arch="x86_64")]
2387     ///     unsafe {
2388     ///         asm!("mov {0}, {0}", in(reg) 0i16);
2389     ///     }
2390     /// }
2391     /// ```
2392     ///
2393     /// This will produce:
2394     ///
2395     /// ```text
2396     /// warning: formatting may not be suitable for sub-register argument
2397     ///  --> src/main.rs:6:19
2398     ///   |
2399     /// 6 |         asm!("mov {0}, {0}", in(reg) 0i16);
2400     ///   |                   ^^^  ^^^           ---- for this argument
2401     ///   |
2402     ///   = note: `#[warn(asm_sub_register)]` on by default
2403     ///   = help: use the `x` modifier to have the register formatted as `ax`
2404     ///   = help: or use the `r` modifier to keep the default formatting of `rax`
2405     /// ```
2406     ///
2407     /// ### Explanation
2408     ///
2409     /// Registers on some architectures can use different names to refer to a
2410     /// subset of the register. By default, the compiler will use the name for
2411     /// the full register size. To explicitly use a subset of the register,
2412     /// you can override the default by using a modifier on the template
2413     /// string operand to specify when subregister to use. This lint is issued
2414     /// if you pass in a value with a smaller data type than the default
2415     /// register size, to alert you of possibly using the incorrect width. To
2416     /// fix this, add the suggested modifier to the template, or cast the
2417     /// value to the correct size.
2418     ///
2419     /// See [register template modifiers] for more details.
2420     ///
2421     /// [register template modifiers]: https://doc.rust-lang.org/nightly/unstable-book/library-features/asm.html#register-template-modifiers
2422     pub ASM_SUB_REGISTER,
2423     Warn,
2424     "using only a subset of a register for inline asm inputs",
2425 }
2426
2427 declare_lint! {
2428     /// The `bad_asm_style` lint detects the use of the `.intel_syntax` and
2429     /// `.att_syntax` directives.
2430     ///
2431     /// ### Example
2432     ///
2433     /// ```rust,ignore (fails on system llvm)
2434     /// #![feature(asm)]
2435     ///
2436     /// fn main() {
2437     ///     #[cfg(target_arch="x86_64")]
2438     ///     unsafe {
2439     ///         asm!(
2440     ///             ".att_syntax",
2441     ///             "movl {0}, {0}", in(reg) 0usize
2442     ///         );
2443     ///     }
2444     /// }
2445     /// ```
2446     ///
2447     /// This will produce:
2448     ///
2449     /// ```text
2450     ///  warning: avoid using `.att_syntax`, prefer using `options(att_syntax)` instead
2451     ///  --> test.rs:7:14
2452     ///   |
2453     /// 7 |             ".att_syntax",
2454     ///   |              ^^^^^^^^^^^
2455     /// 8 |             "movq {0}, {0}", out(reg) _,
2456     /// 9 |         );
2457     ///   |         - help: add option: `, options(att_syntax)`
2458     ///   |
2459     ///   = note: `#[warn(bad_asm_style)]` on by default
2460     /// ```
2461     ///
2462     /// ### Explanation
2463     ///
2464     /// On x86, `asm!` uses the intel assembly syntax by default. While this
2465     /// can be switched using assembler directives like `.att_syntax`, using the
2466     /// `att_syntax` option is recommended instead because it will also properly
2467     /// prefix register placeholders with `%` as required by AT&T syntax.
2468     pub BAD_ASM_STYLE,
2469     Warn,
2470     "incorrect use of inline assembly",
2471 }
2472
2473 declare_lint! {
2474     /// The `unsafe_op_in_unsafe_fn` lint detects unsafe operations in unsafe
2475     /// functions without an explicit unsafe block.
2476     ///
2477     /// ### Example
2478     ///
2479     /// ```rust,compile_fail
2480     /// #![deny(unsafe_op_in_unsafe_fn)]
2481     ///
2482     /// unsafe fn foo() {}
2483     ///
2484     /// unsafe fn bar() {
2485     ///     foo();
2486     /// }
2487     ///
2488     /// fn main() {}
2489     /// ```
2490     ///
2491     /// {{produces}}
2492     ///
2493     /// ### Explanation
2494     ///
2495     /// Currently, an [`unsafe fn`] allows any [unsafe] operation within its
2496     /// body. However, this can increase the surface area of code that needs
2497     /// to be scrutinized for proper behavior. The [`unsafe` block] provides a
2498     /// convenient way to make it clear exactly which parts of the code are
2499     /// performing unsafe operations. In the future, it is desired to change
2500     /// it so that unsafe operations cannot be performed in an `unsafe fn`
2501     /// without an `unsafe` block.
2502     ///
2503     /// The fix to this is to wrap the unsafe code in an `unsafe` block.
2504     ///
2505     /// This lint is "allow" by default since this will affect a large amount
2506     /// of existing code, and the exact plan for increasing the severity is
2507     /// still being considered. See [RFC #2585] and [issue #71668] for more
2508     /// details.
2509     ///
2510     /// [`unsafe fn`]: https://doc.rust-lang.org/reference/unsafe-functions.html
2511     /// [`unsafe` block]: https://doc.rust-lang.org/reference/expressions/block-expr.html#unsafe-blocks
2512     /// [unsafe]: https://doc.rust-lang.org/reference/unsafety.html
2513     /// [RFC #2585]: https://github.com/rust-lang/rfcs/blob/master/text/2585-unsafe-block-in-unsafe-fn.md
2514     /// [issue #71668]: https://github.com/rust-lang/rust/issues/71668
2515     pub UNSAFE_OP_IN_UNSAFE_FN,
2516     Allow,
2517     "unsafe operations in unsafe functions without an explicit unsafe block are deprecated",
2518 }
2519
2520 declare_lint! {
2521     /// The `cenum_impl_drop_cast` lint detects an `as` cast of a field-less
2522     /// `enum` that implements [`Drop`].
2523     ///
2524     /// [`Drop`]: https://doc.rust-lang.org/std/ops/trait.Drop.html
2525     ///
2526     /// ### Example
2527     ///
2528     /// ```rust
2529     /// # #![allow(unused)]
2530     /// enum E {
2531     ///     A,
2532     /// }
2533     ///
2534     /// impl Drop for E {
2535     ///     fn drop(&mut self) {
2536     ///         println!("Drop");
2537     ///     }
2538     /// }
2539     ///
2540     /// fn main() {
2541     ///     let e = E::A;
2542     ///     let i = e as u32;
2543     /// }
2544     /// ```
2545     ///
2546     /// {{produces}}
2547     ///
2548     /// ### Explanation
2549     ///
2550     /// Casting a field-less `enum` that does not implement [`Copy`] to an
2551     /// integer moves the value without calling `drop`. This can result in
2552     /// surprising behavior if it was expected that `drop` should be called.
2553     /// Calling `drop` automatically would be inconsistent with other move
2554     /// operations. Since neither behavior is clear or consistent, it was
2555     /// decided that a cast of this nature will no longer be allowed.
2556     ///
2557     /// This is a [future-incompatible] lint to transition this to a hard error
2558     /// in the future. See [issue #73333] for more details.
2559     ///
2560     /// [future-incompatible]: ../index.md#future-incompatible-lints
2561     /// [issue #73333]: https://github.com/rust-lang/rust/issues/73333
2562     /// [`Copy`]: https://doc.rust-lang.org/std/marker/trait.Copy.html
2563     pub CENUM_IMPL_DROP_CAST,
2564     Warn,
2565     "a C-like enum implementing Drop is cast",
2566     @future_incompatible = FutureIncompatibleInfo {
2567         reference: "issue #73333 <https://github.com/rust-lang/rust/issues/73333>",
2568     };
2569 }
2570
2571 declare_lint! {
2572     /// The `const_evaluatable_unchecked` lint detects a generic constant used
2573     /// in a type.
2574     ///
2575     /// ### Example
2576     ///
2577     /// ```rust
2578     /// const fn foo<T>() -> usize {
2579     ///     if std::mem::size_of::<*mut T>() < 8 { // size of *mut T does not depend on T
2580     ///         4
2581     ///     } else {
2582     ///         8
2583     ///     }
2584     /// }
2585     ///
2586     /// fn test<T>() {
2587     ///     let _ = [0; foo::<T>()];
2588     /// }
2589     /// ```
2590     ///
2591     /// {{produces}}
2592     ///
2593     /// ### Explanation
2594     ///
2595     /// In the 1.43 release, some uses of generic parameters in array repeat
2596     /// expressions were accidentally allowed. This is a [future-incompatible]
2597     /// lint to transition this to a hard error in the future. See [issue
2598     /// #76200] for a more detailed description and possible fixes.
2599     ///
2600     /// [future-incompatible]: ../index.md#future-incompatible-lints
2601     /// [issue #76200]: https://github.com/rust-lang/rust/issues/76200
2602     pub CONST_EVALUATABLE_UNCHECKED,
2603     Warn,
2604     "detects a generic constant is used in a type without a emitting a warning",
2605     @future_incompatible = FutureIncompatibleInfo {
2606         reference: "issue #76200 <https://github.com/rust-lang/rust/issues/76200>",
2607     };
2608 }
2609
2610 declare_lint! {
2611     /// The `function_item_references` lint detects function references that are
2612     /// formatted with [`fmt::Pointer`] or transmuted.
2613     ///
2614     /// [`fmt::Pointer`]: https://doc.rust-lang.org/std/fmt/trait.Pointer.html
2615     ///
2616     /// ### Example
2617     ///
2618     /// ```rust
2619     /// fn foo() { }
2620     ///
2621     /// fn main() {
2622     ///     println!("{:p}", &foo);
2623     /// }
2624     /// ```
2625     ///
2626     /// {{produces}}
2627     ///
2628     /// ### Explanation
2629     ///
2630     /// Taking a reference to a function may be mistaken as a way to obtain a
2631     /// pointer to that function. This can give unexpected results when
2632     /// formatting the reference as a pointer or transmuting it. This lint is
2633     /// issued when function references are formatted as pointers, passed as
2634     /// arguments bound by [`fmt::Pointer`] or transmuted.
2635     pub FUNCTION_ITEM_REFERENCES,
2636     Warn,
2637     "suggest casting to a function pointer when attempting to take references to function items",
2638 }
2639
2640 declare_lint! {
2641     /// The `uninhabited_static` lint detects uninhabited statics.
2642     ///
2643     /// ### Example
2644     ///
2645     /// ```rust
2646     /// enum Void {}
2647     /// extern {
2648     ///     static EXTERN: Void;
2649     /// }
2650     /// ```
2651     ///
2652     /// {{produces}}
2653     ///
2654     /// ### Explanation
2655     ///
2656     /// Statics with an uninhabited type can never be initialized, so they are impossible to define.
2657     /// However, this can be side-stepped with an `extern static`, leading to problems later in the
2658     /// compiler which assumes that there are no initialized uninhabited places (such as locals or
2659     /// statics). This was accidentally allowed, but is being phased out.
2660     pub UNINHABITED_STATIC,
2661     Warn,
2662     "uninhabited static",
2663     @future_incompatible = FutureIncompatibleInfo {
2664         reference: "issue #74840 <https://github.com/rust-lang/rust/issues/74840>",
2665     };
2666 }
2667
2668 declare_lint! {
2669     /// The `useless_deprecated` lint detects deprecation attributes with no effect.
2670     ///
2671     /// ### Example
2672     ///
2673     /// ```rust,compile_fail
2674     /// struct X;
2675     ///
2676     /// #[deprecated = "message"]
2677     /// impl Default for X {
2678     ///     fn default() -> Self {
2679     ///         X
2680     ///     }
2681     /// }
2682     /// ```
2683     ///
2684     /// {{produces}}
2685     ///
2686     /// ### Explanation
2687     ///
2688     /// Deprecation attributes have no effect on trait implementations.
2689     pub USELESS_DEPRECATED,
2690     Deny,
2691     "detects deprecation attributes with no effect",
2692 }
2693
2694 declare_lint! {
2695     /// The `unsupported_naked_functions` lint detects naked function
2696     /// definitions that are unsupported but were previously accepted.
2697     ///
2698     /// ### Example
2699     ///
2700     /// ```rust
2701     /// #![feature(naked_functions)]
2702     ///
2703     /// #[naked]
2704     /// pub fn f() -> u32 {
2705     ///     42
2706     /// }
2707     /// ```
2708     ///
2709     /// {{produces}}
2710     ///
2711     /// ### Explanation
2712     ///
2713     /// The naked functions must be defined using a single inline assembly
2714     /// block.
2715     ///
2716     /// The execution must never fall through past the end of the assembly
2717     /// code so the block must use `noreturn` option. The asm block can also
2718     /// use `att_syntax` option, but other options are not allowed.
2719     ///
2720     /// The asm block must not contain any operands other than `const` and
2721     /// `sym`. Additionally, naked function should specify a non-Rust ABI.
2722     ///
2723     /// While other definitions of naked functions were previously accepted,
2724     /// they are unsupported and might not work reliably. This is a
2725     /// [future-incompatible] lint that will transition into hard error in
2726     /// the future.
2727     ///
2728     /// [future-incompatible]: ../index.md#future-incompatible-lints
2729     pub UNSUPPORTED_NAKED_FUNCTIONS,
2730     Warn,
2731     "unsupported naked function definitions",
2732     @future_incompatible = FutureIncompatibleInfo {
2733         reference: "issue #32408 <https://github.com/rust-lang/rust/issues/32408>",
2734     };
2735 }
2736
2737 declare_lint! {
2738     /// The `ineffective_unstable_trait_impl` lint detects `#[unstable]` attributes which are not used.
2739     ///
2740     /// ### Example
2741     ///
2742     /// ```compile_fail
2743     /// #![feature(staged_api)]
2744     ///
2745     /// #[derive(Clone)]
2746     /// #[stable(feature = "x", since = "1")]
2747     /// struct S {}
2748     ///
2749     /// #[unstable(feature = "y", issue = "none")]
2750     /// impl Copy for S {}
2751     /// ```
2752     ///
2753     /// {{produces}}
2754     ///
2755     /// ### Explanation
2756     ///
2757     /// `staged_api` does not currently support using a stability attribute on `impl` blocks.
2758     /// `impl`s are always stable if both the type and trait are stable, and always unstable otherwise.
2759     pub INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
2760     Deny,
2761     "detects `#[unstable]` on stable trait implementations for stable types"
2762 }
2763
2764 declare_lint! {
2765     /// The `semicolon_in_expressions_from_macros` lint detects trailing semicolons
2766     /// in macro bodies when the macro is invoked in expression position.
2767     /// This was previous accepted, but is being phased out.
2768     ///
2769     /// ### Example
2770     ///
2771     /// ```rust,compile_fail
2772     /// #![deny(semicolon_in_expressions_from_macros)]
2773     /// macro_rules! foo {
2774     ///     () => { true; }
2775     /// }
2776     ///
2777     /// fn main() {
2778     ///     let val = match true {
2779     ///         true => false,
2780     ///         _ => foo!()
2781     ///     };
2782     /// }
2783     /// ```
2784     ///
2785     /// {{produces}}
2786     ///
2787     /// ### Explanation
2788     ///
2789     /// Previous, Rust ignored trailing semicolon in a macro
2790     /// body when a macro was invoked in expression position.
2791     /// However, this makes the treatment of semicolons in the language
2792     /// inconsistent, and could lead to unexpected runtime behavior
2793     /// in some circumstances (e.g. if the macro author expects
2794     /// a value to be dropped).
2795     ///
2796     /// This is a [future-incompatible] lint to transition this
2797     /// to a hard error in the future. See [issue #79813] for more details.
2798     ///
2799     /// [issue #79813]: https://github.com/rust-lang/rust/issues/79813
2800     /// [future-incompatible]: ../index.md#future-incompatible-lints
2801     pub SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
2802     Allow,
2803     "trailing semicolon in macro body used as expression",
2804     @future_incompatible = FutureIncompatibleInfo {
2805         reference: "issue #79813 <https://github.com/rust-lang/rust/issues/79813>",
2806     };
2807 }
2808
2809 declare_lint! {
2810     /// The `legacy_derive_helpers` lint detects derive helper attributes
2811     /// that are used before they are introduced.
2812     ///
2813     /// ### Example
2814     ///
2815     /// ```rust,ignore (needs extern crate)
2816     /// #[serde(rename_all = "camelCase")]
2817     /// #[derive(Deserialize)]
2818     /// struct S { /* fields */ }
2819     /// ```
2820     ///
2821     /// produces:
2822     ///
2823     /// ```text
2824     /// warning: derive helper attribute is used before it is introduced
2825     ///   --> $DIR/legacy-derive-helpers.rs:1:3
2826     ///    |
2827     ///  1 | #[serde(rename_all = "camelCase")]
2828     ///    |   ^^^^^
2829     /// ...
2830     ///  2 | #[derive(Deserialize)]
2831     ///    |          ----------- the attribute is introduced here
2832     /// ```
2833     ///
2834     /// ### Explanation
2835     ///
2836     /// Attributes like this work for historical reasons, but attribute expansion works in
2837     /// left-to-right order in general, so, to resolve `#[serde]`, compiler has to try to "look
2838     /// into the future" at not yet expanded part of the item , but such attempts are not always
2839     /// reliable.
2840     ///
2841     /// To fix the warning place the helper attribute after its corresponding derive.
2842     /// ```rust,ignore (needs extern crate)
2843     /// #[derive(Deserialize)]
2844     /// #[serde(rename_all = "camelCase")]
2845     /// struct S { /* fields */ }
2846     /// ```
2847     pub LEGACY_DERIVE_HELPERS,
2848     Warn,
2849     "detects derive helper attributes that are used before they are introduced",
2850     @future_incompatible = FutureIncompatibleInfo {
2851         reference: "issue #79202 <https://github.com/rust-lang/rust/issues/79202>",
2852     };
2853 }
2854
2855 declare_lint! {
2856     /// The `large_assignments` lint detects when objects of large
2857     /// types are being moved around.
2858     ///
2859     /// ### Example
2860     ///
2861     /// ```rust,ignore (can crash on some platforms)
2862     /// let x = [0; 50000];
2863     /// let y = x;
2864     /// ```
2865     ///
2866     /// produces:
2867     ///
2868     /// ```text
2869     /// warning: moving a large value
2870     ///   --> $DIR/move-large.rs:1:3
2871     ///   let y = x;
2872     ///           - Copied large value here
2873     /// ```
2874     ///
2875     /// ### Explanation
2876     ///
2877     /// When using a large type in a plain assignment or in a function
2878     /// argument, idiomatic code can be inefficient.
2879     /// Ideally appropriate optimizations would resolve this, but such
2880     /// optimizations are only done in a best-effort manner.
2881     /// This lint will trigger on all sites of large moves and thus allow the
2882     /// user to resolve them in code.
2883     pub LARGE_ASSIGNMENTS,
2884     Warn,
2885     "detects large moves or copies",
2886 }
2887
2888 declare_lint_pass! {
2889     /// Does nothing as a lint pass, but registers some `Lint`s
2890     /// that are used by other parts of the compiler.
2891     HardwiredLints => [
2892         FORBIDDEN_LINT_GROUPS,
2893         ILLEGAL_FLOATING_POINT_LITERAL_PATTERN,
2894         ARITHMETIC_OVERFLOW,
2895         UNCONDITIONAL_PANIC,
2896         UNUSED_IMPORTS,
2897         UNUSED_EXTERN_CRATES,
2898         UNUSED_CRATE_DEPENDENCIES,
2899         UNUSED_QUALIFICATIONS,
2900         UNKNOWN_LINTS,
2901         UNUSED_VARIABLES,
2902         UNUSED_ASSIGNMENTS,
2903         DEAD_CODE,
2904         UNREACHABLE_CODE,
2905         UNREACHABLE_PATTERNS,
2906         OVERLAPPING_RANGE_ENDPOINTS,
2907         BINDINGS_WITH_VARIANT_NAME,
2908         UNUSED_MACROS,
2909         WARNINGS,
2910         UNUSED_FEATURES,
2911         STABLE_FEATURES,
2912         UNKNOWN_CRATE_TYPES,
2913         TRIVIAL_CASTS,
2914         TRIVIAL_NUMERIC_CASTS,
2915         PRIVATE_IN_PUBLIC,
2916         EXPORTED_PRIVATE_DEPENDENCIES,
2917         PUB_USE_OF_PRIVATE_EXTERN_CRATE,
2918         INVALID_TYPE_PARAM_DEFAULT,
2919         CONST_ERR,
2920         RENAMED_AND_REMOVED_LINTS,
2921         UNALIGNED_REFERENCES,
2922         CONST_ITEM_MUTATION,
2923         PATTERNS_IN_FNS_WITHOUT_BODY,
2924         MISSING_FRAGMENT_SPECIFIER,
2925         LATE_BOUND_LIFETIME_ARGUMENTS,
2926         ORDER_DEPENDENT_TRAIT_OBJECTS,
2927         COHERENCE_LEAK_CHECK,
2928         DEPRECATED,
2929         UNUSED_UNSAFE,
2930         UNUSED_MUT,
2931         UNCONDITIONAL_RECURSION,
2932         SINGLE_USE_LIFETIMES,
2933         UNUSED_LIFETIMES,
2934         UNUSED_LABELS,
2935         TYVAR_BEHIND_RAW_POINTER,
2936         ELIDED_LIFETIMES_IN_PATHS,
2937         BARE_TRAIT_OBJECTS,
2938         ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
2939         UNSTABLE_NAME_COLLISIONS,
2940         IRREFUTABLE_LET_PATTERNS,
2941         WHERE_CLAUSES_OBJECT_SAFETY,
2942         PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
2943         MACRO_USE_EXTERN_CRATE,
2944         MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2945         ILL_FORMED_ATTRIBUTE_INPUT,
2946         CONFLICTING_REPR_HINTS,
2947         META_VARIABLE_MISUSE,
2948         DEPRECATED_IN_FUTURE,
2949         AMBIGUOUS_ASSOCIATED_ITEMS,
2950         MUTABLE_BORROW_RESERVATION_CONFLICT,
2951         INDIRECT_STRUCTURAL_MATCH,
2952         POINTER_STRUCTURAL_MATCH,
2953         NONTRIVIAL_STRUCTURAL_MATCH,
2954         SOFT_UNSTABLE,
2955         INLINE_NO_SANITIZE,
2956         BAD_ASM_STYLE,
2957         ASM_SUB_REGISTER,
2958         UNSAFE_OP_IN_UNSAFE_FN,
2959         INCOMPLETE_INCLUDE,
2960         CENUM_IMPL_DROP_CAST,
2961         CONST_EVALUATABLE_UNCHECKED,
2962         INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
2963         UNINHABITED_STATIC,
2964         FUNCTION_ITEM_REFERENCES,
2965         USELESS_DEPRECATED,
2966         UNSUPPORTED_NAKED_FUNCTIONS,
2967         MISSING_ABI,
2968         INVALID_DOC_ATTRIBUTES,
2969         SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
2970         DISJOINT_CAPTURE_MIGRATION,
2971         LEGACY_DERIVE_HELPERS,
2972         PROC_MACRO_BACK_COMPAT,
2973         OR_PATTERNS_BACK_COMPAT,
2974         LARGE_ASSIGNMENTS,
2975         FUTURE_PRELUDE_COLLISION,
2976     ]
2977 }
2978
2979 declare_lint! {
2980     /// The `unused_doc_comments` lint detects doc comments that aren't used
2981     /// by `rustdoc`.
2982     ///
2983     /// ### Example
2984     ///
2985     /// ```rust
2986     /// /// docs for x
2987     /// let x = 12;
2988     /// ```
2989     ///
2990     /// {{produces}}
2991     ///
2992     /// ### Explanation
2993     ///
2994     /// `rustdoc` does not use doc comments in all positions, and so the doc
2995     /// comment will be ignored. Try changing it to a normal comment with `//`
2996     /// to avoid the warning.
2997     pub UNUSED_DOC_COMMENTS,
2998     Warn,
2999     "detects doc comments that aren't used by rustdoc"
3000 }
3001
3002 declare_lint! {
3003     /// The `disjoint_capture_migration` lint detects variables that aren't completely
3004     /// captured when the feature `capture_disjoint_fields` is enabled and it affects the Drop
3005     /// order of at least one path starting at this variable.
3006     /// It can also detect when a variable implements a trait, but one of its field does not and
3007     /// the field is captured by a closure and used with the assumption that said field implements
3008     /// the same trait as the root variable.
3009     ///
3010     /// ### Example of drop reorder
3011     ///
3012     /// ```rust,compile_fail
3013     /// # #![deny(disjoint_capture_migration)]
3014     /// # #![allow(unused)]
3015     /// struct FancyInteger(i32);
3016     ///
3017     /// impl Drop for FancyInteger {
3018     ///     fn drop(&mut self) {
3019     ///         println!("Just dropped {}", self.0);
3020     ///     }
3021     /// }
3022     ///
3023     /// struct Point { x: FancyInteger, y: FancyInteger }
3024     ///
3025     /// fn main() {
3026     ///   let p = Point { x: FancyInteger(10), y: FancyInteger(20) };
3027     ///
3028     ///   let c = || {
3029     ///      let x = p.x;
3030     ///   };
3031     ///
3032     ///   c();
3033     ///
3034     ///   // ... More code ...
3035     /// }
3036     /// ```
3037     ///
3038     /// {{produces}}
3039     ///
3040     /// ### Explanation
3041     ///
3042     /// In the above example `p.y` will be dropped at the end of `f` instead of with `c` if
3043     /// the feature `capture_disjoint_fields` is enabled.
3044     ///
3045     /// ### Example of auto-trait
3046     ///
3047     /// ```rust,compile_fail
3048     /// #![deny(disjoint_capture_migration)]
3049     /// use std::thread;
3050     ///
3051     /// struct Pointer (*mut i32);
3052     /// unsafe impl Send for Pointer {}
3053     ///
3054     /// fn main() {
3055     ///     let mut f = 10;
3056     ///     let fptr = Pointer(&mut f as *mut i32);
3057     ///     thread::spawn(move || unsafe {
3058     ///         *fptr.0 = 20;
3059     ///     });
3060     /// }
3061     /// ```
3062     ///
3063     /// {{produces}}
3064     ///
3065     /// ### Explanation
3066     ///
3067     /// In the above example `fptr.0` is captured when feature `capture_disjoint_fields` is enabled.
3068     /// The field is of type *mut i32 which doesn't implement Send, making the code invalid as the
3069     /// field cannot be sent between thread safely.
3070     pub DISJOINT_CAPTURE_MIGRATION,
3071     Allow,
3072     "Drop reorder and auto traits error because of `capture_disjoint_fields`"
3073 }
3074
3075 declare_lint_pass!(UnusedDocComment => [UNUSED_DOC_COMMENTS]);
3076
3077 declare_lint! {
3078     /// The `missing_abi` lint detects cases where the ABI is omitted from
3079     /// extern declarations.
3080     ///
3081     /// ### Example
3082     ///
3083     /// ```rust,compile_fail
3084     /// #![deny(missing_abi)]
3085     ///
3086     /// extern fn foo() {}
3087     /// ```
3088     ///
3089     /// {{produces}}
3090     ///
3091     /// ### Explanation
3092     ///
3093     /// Historically, Rust implicitly selected C as the ABI for extern
3094     /// declarations. We expect to add new ABIs, like `C-unwind`, in the future,
3095     /// though this has not yet happened, and especially with their addition
3096     /// seeing the ABI easily will make code review easier.
3097     pub MISSING_ABI,
3098     Allow,
3099     "No declared ABI for extern declaration"
3100 }
3101
3102 declare_lint! {
3103     /// The `invalid_doc_attributes` lint detects when the `#[doc(...)]` is
3104     /// misused.
3105     ///
3106     /// ### Example
3107     ///
3108     /// ```rust,compile_fail
3109     /// #![deny(warnings)]
3110     ///
3111     /// pub mod submodule {
3112     ///     #![doc(test(no_crate_inject))]
3113     /// }
3114     /// ```
3115     ///
3116     /// {{produces}}
3117     ///
3118     /// ### Explanation
3119     ///
3120     /// Previously, there were very like checks being performed on `#[doc(..)]`
3121     /// unlike the other attributes. It'll now catch all the issues that it
3122     /// silently ignored previously.
3123     pub INVALID_DOC_ATTRIBUTES,
3124     Warn,
3125     "detects invalid `#[doc(...)]` attributes",
3126     @future_incompatible = FutureIncompatibleInfo {
3127         reference: "issue #82730 <https://github.com/rust-lang/rust/issues/82730>",
3128     };
3129 }
3130
3131 declare_lint! {
3132     /// The `proc_macro_back_compat` lint detects uses of old versions of certain
3133     /// proc-macro crates, which have hardcoded workarounds in the compiler.
3134     ///
3135     /// ### Example
3136     ///
3137     /// ```rust,ignore (needs-dependency)
3138     ///
3139     /// use time_macros_impl::impl_macros;
3140     /// struct Foo;
3141     /// impl_macros!(Foo);
3142     /// ```
3143     ///
3144     /// This will produce:
3145     ///
3146     /// ```text
3147     /// warning: using an old version of `time-macros-impl`
3148     ///   ::: $DIR/group-compat-hack.rs:27:5
3149     ///    |
3150     /// LL |     impl_macros!(Foo);
3151     ///    |     ------------------ in this macro invocation
3152     ///    |
3153     ///    = note: `#[warn(proc_macro_back_compat)]` on by default
3154     ///    = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3155     ///    = note: for more information, see issue #83125 <https://github.com/rust-lang/rust/issues/83125>
3156     ///    = note: the `time-macros-impl` crate will stop compiling in futures version of Rust. Please update to the latest version of the `time` crate to avoid breakage
3157     ///    = note: this warning originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
3158     /// ```
3159     ///
3160     /// ### Explanation
3161     ///
3162     /// Eventually, the backwards-compatibility hacks present in the compiler will be removed,
3163     /// causing older versions of certain crates to stop compiling.
3164     /// This is a [future-incompatible] lint to ease the transition to an error.
3165     /// See [issue #83125] for more details.
3166     ///
3167     /// [issue #83125]: https://github.com/rust-lang/rust/issues/83125
3168     /// [future-incompatible]: ../index.md#future-incompatible-lints
3169     pub PROC_MACRO_BACK_COMPAT,
3170     Warn,
3171     "detects usage of old versions of certain proc-macro crates",
3172     @future_incompatible = FutureIncompatibleInfo {
3173         reference: "issue #83125 <https://github.com/rust-lang/rust/issues/83125>",
3174         future_breakage: Some(FutureBreakage {
3175             date: None
3176         })
3177     };
3178 }
3179
3180 declare_lint! {
3181     /// The `or_patterns_back_compat` lint detects usage of old versions of or-patterns.
3182     ///
3183     /// ### Example
3184     ///
3185     /// ```rust,compile_fail
3186     /// #![deny(or_patterns_back_compat)]
3187     /// macro_rules! match_any {
3188     ///     ( $expr:expr , $( $( $pat:pat )|+ => $expr_arm:expr ),+ ) => {
3189     ///         match $expr {
3190     ///             $(
3191     ///                 $( $pat => $expr_arm, )+
3192     ///             )+
3193     ///         }
3194     ///     };
3195     /// }
3196     ///
3197     /// fn main() {
3198     ///     let result: Result<i64, i32> = Err(42);
3199     ///     let int: i64 = match_any!(result, Ok(i) | Err(i) => i.into());
3200     ///     assert_eq!(int, 42);
3201     /// }
3202     /// ```
3203     ///
3204     /// {{produces}}
3205     ///
3206     /// ### Explanation
3207     ///
3208     /// In Rust 2021, the pat matcher will match new patterns, which include the | character.
3209     pub OR_PATTERNS_BACK_COMPAT,
3210     Allow,
3211     "detects usage of old versions of or-patterns",
3212     @future_incompatible = FutureIncompatibleInfo {
3213         reference: "issue #84869 <https://github.com/rust-lang/rust/issues/84869>",
3214         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2021),
3215     };
3216 }
3217
3218 declare_lint! {
3219     /// The `future_prelude_collision` lint detects the usage of trait methods which are ambiguous
3220     /// with traits added to the prelude in future editions.
3221     ///
3222     /// ### Example
3223     ///
3224     /// ```rust,compile_fail
3225     /// #![deny(future_prelude_collision)]
3226     ///
3227     /// trait Foo {
3228     ///     fn try_into(self) -> Result<String, !>;
3229     /// }
3230     ///
3231     /// impl Foo for &str {
3232     ///     fn try_into(self) -> Result<String, !> {
3233     ///         Ok(String::from(self))
3234     ///     }
3235     /// }
3236     ///
3237     /// fn main() {
3238     ///     let x: String = "3".try_into().unwrap();
3239     ///     //                  ^^^^^^^^
3240     ///     // This call to try_into matches both Foo:try_into and TryInto::try_into as
3241     ///     // `TryInto` has been added to the Rust prelude in 2021 edition.
3242     ///     println!("{}", x);
3243     /// }
3244     /// ```
3245     ///
3246     /// {{produces}}
3247     ///
3248     /// ### Explanation
3249     ///
3250     /// In Rust 2021, one of the important introductions is the [prelude changes], which add
3251     /// `TryFrom`, `TryInto`, and `FromIterator` into the standard library's prelude. Since this
3252     /// results in an amiguity as to which method/function to call when an existing `try_into`
3253     ///  method is called via dot-call syntax or a `try_from`/`from_iter` associated function
3254     ///  is called directly on a type.
3255     ///
3256     /// [prelude changes]: https://blog.rust-lang.org/inside-rust/2021/03/04/planning-rust-2021.html#prelude-changes
3257     pub FUTURE_PRELUDE_COLLISION,
3258     Allow,
3259     "detects the usage of trait methods which are ambiguous with traits added to the \
3260         prelude in future editions",
3261     @future_incompatible = FutureIncompatibleInfo {
3262         reference: "issue #85684 <https://github.com/rust-lang/rust/issues/85684>",
3263         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2021),
3264     };
3265 }