]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_lint_defs/src/builtin.rs
Extend `BYTE_SLICE_IN_PACKED_STRUCT_WITH_DERIVE`.
[rust.git] / compiler / rustc_lint_defs / src / builtin.rs
1 //! Some lints that are built in to the compiler.
2 //!
3 //! These are the built-in lints that are emitted direct in the main
4 //! compiler code, rather than using their own custom pass. Those
5 //! lints are all available in `rustc_lint::builtin`.
6
7 use crate::{declare_lint, declare_lint_pass, FutureIncompatibilityReason};
8 use rustc_span::edition::Edition;
9 use rustc_span::symbol::sym;
10
11 declare_lint! {
12     /// The `forbidden_lint_groups` lint detects violations of
13     /// `forbid` applied to a lint group. Due to a bug in the compiler,
14     /// these used to be overlooked entirely. They now generate a warning.
15     ///
16     /// ### Example
17     ///
18     /// ```rust
19     /// #![forbid(warnings)]
20     /// #![deny(bad_style)]
21     ///
22     /// fn main() {}
23     /// ```
24     ///
25     /// {{produces}}
26     ///
27     /// ### Recommended fix
28     ///
29     /// If your crate is using `#![forbid(warnings)]`,
30     /// we recommend that you change to `#![deny(warnings)]`.
31     ///
32     /// ### Explanation
33     ///
34     /// Due to a compiler bug, applying `forbid` to lint groups
35     /// previously had no effect. The bug is now fixed but instead of
36     /// enforcing `forbid` we issue this future-compatibility warning
37     /// to avoid breaking existing crates.
38     pub FORBIDDEN_LINT_GROUPS,
39     Warn,
40     "applying forbid to lint-groups",
41     @future_incompatible = FutureIncompatibleInfo {
42         reference: "issue #81670 <https://github.com/rust-lang/rust/issues/81670>",
43     };
44 }
45
46 declare_lint! {
47     /// The `ill_formed_attribute_input` lint detects ill-formed attribute
48     /// inputs that were previously accepted and used in practice.
49     ///
50     /// ### Example
51     ///
52     /// ```rust,compile_fail
53     /// #[inline = "this is not valid"]
54     /// fn foo() {}
55     /// ```
56     ///
57     /// {{produces}}
58     ///
59     /// ### Explanation
60     ///
61     /// Previously, inputs for many built-in attributes weren't validated and
62     /// nonsensical attribute inputs were accepted. After validation was
63     /// added, it was determined that some existing projects made use of these
64     /// invalid forms. This is a [future-incompatible] lint to transition this
65     /// to a hard error in the future. See [issue #57571] for more details.
66     ///
67     /// Check the [attribute reference] for details on the valid inputs for
68     /// attributes.
69     ///
70     /// [issue #57571]: https://github.com/rust-lang/rust/issues/57571
71     /// [attribute reference]: https://doc.rust-lang.org/nightly/reference/attributes.html
72     /// [future-incompatible]: ../index.md#future-incompatible-lints
73     pub ILL_FORMED_ATTRIBUTE_INPUT,
74     Deny,
75     "ill-formed attribute inputs that were previously accepted and used in practice",
76     @future_incompatible = FutureIncompatibleInfo {
77         reference: "issue #57571 <https://github.com/rust-lang/rust/issues/57571>",
78     };
79     crate_level_only
80 }
81
82 declare_lint! {
83     /// The `conflicting_repr_hints` lint detects [`repr` attributes] with
84     /// conflicting hints.
85     ///
86     /// [`repr` attributes]: https://doc.rust-lang.org/reference/type-layout.html#representations
87     ///
88     /// ### Example
89     ///
90     /// ```rust,compile_fail
91     /// #[repr(u32, u64)]
92     /// enum Foo {
93     ///     Variant1,
94     /// }
95     /// ```
96     ///
97     /// {{produces}}
98     ///
99     /// ### Explanation
100     ///
101     /// The compiler incorrectly accepted these conflicting representations in
102     /// the past. This is a [future-incompatible] lint to transition this to a
103     /// hard error in the future. See [issue #68585] for more details.
104     ///
105     /// To correct the issue, remove one of the conflicting hints.
106     ///
107     /// [issue #68585]: https://github.com/rust-lang/rust/issues/68585
108     /// [future-incompatible]: ../index.md#future-incompatible-lints
109     pub CONFLICTING_REPR_HINTS,
110     Deny,
111     "conflicts between `#[repr(..)]` hints that were previously accepted and used in practice",
112     @future_incompatible = FutureIncompatibleInfo {
113         reference: "issue #68585 <https://github.com/rust-lang/rust/issues/68585>",
114     };
115 }
116
117 declare_lint! {
118     /// The `meta_variable_misuse` lint detects possible meta-variable misuse
119     /// in macro definitions.
120     ///
121     /// ### Example
122     ///
123     /// ```rust,compile_fail
124     /// #![deny(meta_variable_misuse)]
125     ///
126     /// macro_rules! foo {
127     ///     () => {};
128     ///     ($( $i:ident = $($j:ident),+ );*) => { $( $( $i = $k; )+ )* };
129     /// }
130     ///
131     /// fn main() {
132     ///     foo!();
133     /// }
134     /// ```
135     ///
136     /// {{produces}}
137     ///
138     /// ### Explanation
139     ///
140     /// There are quite a few different ways a [`macro_rules`] macro can be
141     /// improperly defined. Many of these errors were previously only detected
142     /// when the macro was expanded or not at all. This lint is an attempt to
143     /// catch some of these problems when the macro is *defined*.
144     ///
145     /// This lint is "allow" by default because it may have false positives
146     /// and other issues. See [issue #61053] for more details.
147     ///
148     /// [`macro_rules`]: https://doc.rust-lang.org/reference/macros-by-example.html
149     /// [issue #61053]: https://github.com/rust-lang/rust/issues/61053
150     pub META_VARIABLE_MISUSE,
151     Allow,
152     "possible meta-variable misuse at macro definition"
153 }
154
155 declare_lint! {
156     /// The `incomplete_include` lint detects the use of the [`include!`]
157     /// macro with a file that contains more than one expression.
158     ///
159     /// [`include!`]: https://doc.rust-lang.org/std/macro.include.html
160     ///
161     /// ### Example
162     ///
163     /// ```rust,ignore (needs separate file)
164     /// fn main() {
165     ///     include!("foo.txt");
166     /// }
167     /// ```
168     ///
169     /// where the file `foo.txt` contains:
170     ///
171     /// ```text
172     /// println!("hi!");
173     /// ```
174     ///
175     /// produces:
176     ///
177     /// ```text
178     /// error: include macro expected single expression in source
179     ///  --> foo.txt:1:14
180     ///   |
181     /// 1 | println!("1");
182     ///   |              ^
183     ///   |
184     ///   = note: `#[deny(incomplete_include)]` on by default
185     /// ```
186     ///
187     /// ### Explanation
188     ///
189     /// The [`include!`] macro is currently only intended to be used to
190     /// include a single [expression] or multiple [items]. Historically it
191     /// would ignore any contents after the first expression, but that can be
192     /// confusing. In the example above, the `println!` expression ends just
193     /// before the semicolon, making the semicolon "extra" information that is
194     /// ignored. Perhaps even more surprising, if the included file had
195     /// multiple print statements, the subsequent ones would be ignored!
196     ///
197     /// One workaround is to place the contents in braces to create a [block
198     /// expression]. Also consider alternatives, like using functions to
199     /// encapsulate the expressions, or use [proc-macros].
200     ///
201     /// This is a lint instead of a hard error because existing projects were
202     /// found to hit this error. To be cautious, it is a lint for now. The
203     /// future semantics of the `include!` macro are also uncertain, see
204     /// [issue #35560].
205     ///
206     /// [items]: https://doc.rust-lang.org/reference/items.html
207     /// [expression]: https://doc.rust-lang.org/reference/expressions.html
208     /// [block expression]: https://doc.rust-lang.org/reference/expressions/block-expr.html
209     /// [proc-macros]: https://doc.rust-lang.org/reference/procedural-macros.html
210     /// [issue #35560]: https://github.com/rust-lang/rust/issues/35560
211     pub INCOMPLETE_INCLUDE,
212     Deny,
213     "trailing content in included file"
214 }
215
216 declare_lint! {
217     /// The `arithmetic_overflow` lint detects that an arithmetic operation
218     /// will [overflow].
219     ///
220     /// [overflow]: https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow
221     ///
222     /// ### Example
223     ///
224     /// ```rust,compile_fail
225     /// 1_i32 << 32;
226     /// ```
227     ///
228     /// {{produces}}
229     ///
230     /// ### Explanation
231     ///
232     /// It is very likely a mistake to perform an arithmetic operation that
233     /// overflows its value. If the compiler is able to detect these kinds of
234     /// overflows at compile-time, it will trigger this lint. Consider
235     /// adjusting the expression to avoid overflow, or use a data type that
236     /// will not overflow.
237     pub ARITHMETIC_OVERFLOW,
238     Deny,
239     "arithmetic operation overflows"
240 }
241
242 declare_lint! {
243     /// The `unconditional_panic` lint detects an operation that will cause a
244     /// panic at runtime.
245     ///
246     /// ### Example
247     ///
248     /// ```rust,compile_fail
249     /// # #![allow(unused)]
250     /// let x = 1 / 0;
251     /// ```
252     ///
253     /// {{produces}}
254     ///
255     /// ### Explanation
256     ///
257     /// This lint detects code that is very likely incorrect because it will
258     /// always panic, such as division by zero and out-of-bounds array
259     /// accesses. Consider adjusting your code if this is a bug, or using the
260     /// `panic!` or `unreachable!` macro instead in case the panic is intended.
261     pub UNCONDITIONAL_PANIC,
262     Deny,
263     "operation will cause a panic at runtime"
264 }
265
266 declare_lint! {
267     /// The `unused_imports` lint detects imports that are never used.
268     ///
269     /// ### Example
270     ///
271     /// ```rust
272     /// use std::collections::HashMap;
273     /// ```
274     ///
275     /// {{produces}}
276     ///
277     /// ### Explanation
278     ///
279     /// Unused imports may signal a mistake or unfinished code, and clutter
280     /// the code, and should be removed. If you intended to re-export the item
281     /// to make it available outside of the module, add a visibility modifier
282     /// like `pub`.
283     pub UNUSED_IMPORTS,
284     Warn,
285     "imports that are never used"
286 }
287
288 declare_lint! {
289     /// The `must_not_suspend` lint guards against values that shouldn't be held across suspend points
290     /// (`.await`)
291     ///
292     /// ### Example
293     ///
294     /// ```rust
295     /// #![feature(must_not_suspend)]
296     /// #![warn(must_not_suspend)]
297     ///
298     /// #[must_not_suspend]
299     /// struct SyncThing {}
300     ///
301     /// async fn yield_now() {}
302     ///
303     /// pub async fn uhoh() {
304     ///     let guard = SyncThing {};
305     ///     yield_now().await;
306     /// }
307     /// ```
308     ///
309     /// {{produces}}
310     ///
311     /// ### Explanation
312     ///
313     /// The `must_not_suspend` lint detects values that are marked with the `#[must_not_suspend]`
314     /// attribute being held across suspend points. A "suspend" point is usually a `.await` in an async
315     /// function.
316     ///
317     /// This attribute can be used to mark values that are semantically incorrect across suspends
318     /// (like certain types of timers), values that have async alternatives, and values that
319     /// regularly cause problems with the `Send`-ness of async fn's returned futures (like
320     /// `MutexGuard`'s)
321     ///
322     pub MUST_NOT_SUSPEND,
323     Allow,
324     "use of a `#[must_not_suspend]` value across a yield point",
325     @feature_gate = rustc_span::symbol::sym::must_not_suspend;
326 }
327
328 declare_lint! {
329     /// The `unused_extern_crates` lint guards against `extern crate` items
330     /// that are never used.
331     ///
332     /// ### Example
333     ///
334     /// ```rust,compile_fail
335     /// #![deny(unused_extern_crates)]
336     /// extern crate proc_macro;
337     /// ```
338     ///
339     /// {{produces}}
340     ///
341     /// ### Explanation
342     ///
343     /// `extern crate` items that are unused have no effect and should be
344     /// removed. Note that there are some cases where specifying an `extern
345     /// crate` is desired for the side effect of ensuring the given crate is
346     /// linked, even though it is not otherwise directly referenced. The lint
347     /// can be silenced by aliasing the crate to an underscore, such as
348     /// `extern crate foo as _`. Also note that it is no longer idiomatic to
349     /// use `extern crate` in the [2018 edition], as extern crates are now
350     /// automatically added in scope.
351     ///
352     /// This lint is "allow" by default because it can be noisy, and produce
353     /// false-positives. If a dependency is being removed from a project, it
354     /// is recommended to remove it from the build configuration (such as
355     /// `Cargo.toml`) to ensure stale build entries aren't left behind.
356     ///
357     /// [2018 edition]: https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-clarity.html#no-more-extern-crate
358     pub UNUSED_EXTERN_CRATES,
359     Allow,
360     "extern crates that are never used"
361 }
362
363 declare_lint! {
364     /// The `unused_crate_dependencies` lint detects crate dependencies that
365     /// are never used.
366     ///
367     /// ### Example
368     ///
369     /// ```rust,ignore (needs extern crate)
370     /// #![deny(unused_crate_dependencies)]
371     /// ```
372     ///
373     /// This will produce:
374     ///
375     /// ```text
376     /// error: external crate `regex` unused in `lint_example`: remove the dependency or add `use regex as _;`
377     ///   |
378     /// note: the lint level is defined here
379     ///  --> src/lib.rs:1:9
380     ///   |
381     /// 1 | #![deny(unused_crate_dependencies)]
382     ///   |         ^^^^^^^^^^^^^^^^^^^^^^^^^
383     /// ```
384     ///
385     /// ### Explanation
386     ///
387     /// After removing the code that uses a dependency, this usually also
388     /// requires removing the dependency from the build configuration.
389     /// However, sometimes that step can be missed, which leads to time wasted
390     /// building dependencies that are no longer used. This lint can be
391     /// enabled to detect dependencies that are never used (more specifically,
392     /// any dependency passed with the `--extern` command-line flag that is
393     /// never referenced via [`use`], [`extern crate`], or in any [path]).
394     ///
395     /// This lint is "allow" by default because it can provide false positives
396     /// depending on how the build system is configured. For example, when
397     /// using Cargo, a "package" consists of multiple crates (such as a
398     /// library and a binary), but the dependencies are defined for the
399     /// package as a whole. If there is a dependency that is only used in the
400     /// binary, but not the library, then the lint will be incorrectly issued
401     /// in the library.
402     ///
403     /// [path]: https://doc.rust-lang.org/reference/paths.html
404     /// [`use`]: https://doc.rust-lang.org/reference/items/use-declarations.html
405     /// [`extern crate`]: https://doc.rust-lang.org/reference/items/extern-crates.html
406     pub UNUSED_CRATE_DEPENDENCIES,
407     Allow,
408     "crate dependencies that are never used",
409     crate_level_only
410 }
411
412 declare_lint! {
413     /// The `unused_qualifications` lint detects unnecessarily qualified
414     /// names.
415     ///
416     /// ### Example
417     ///
418     /// ```rust,compile_fail
419     /// #![deny(unused_qualifications)]
420     /// mod foo {
421     ///     pub fn bar() {}
422     /// }
423     ///
424     /// fn main() {
425     ///     use foo::bar;
426     ///     foo::bar();
427     /// }
428     /// ```
429     ///
430     /// {{produces}}
431     ///
432     /// ### Explanation
433     ///
434     /// If an item from another module is already brought into scope, then
435     /// there is no need to qualify it in this case. You can call `bar()`
436     /// directly, without the `foo::`.
437     ///
438     /// This lint is "allow" by default because it is somewhat pedantic, and
439     /// doesn't indicate an actual problem, but rather a stylistic choice, and
440     /// can be noisy when refactoring or moving around code.
441     pub UNUSED_QUALIFICATIONS,
442     Allow,
443     "detects unnecessarily qualified names"
444 }
445
446 declare_lint! {
447     /// The `unknown_lints` lint detects unrecognized lint attributes.
448     ///
449     /// ### Example
450     ///
451     /// ```rust
452     /// #![allow(not_a_real_lint)]
453     /// ```
454     ///
455     /// {{produces}}
456     ///
457     /// ### Explanation
458     ///
459     /// It is usually a mistake to specify a lint that does not exist. Check
460     /// the spelling, and check the lint listing for the correct name. Also
461     /// consider if you are using an old version of the compiler, and the lint
462     /// is only available in a newer version.
463     pub UNKNOWN_LINTS,
464     Warn,
465     "unrecognized lint attribute"
466 }
467
468 declare_lint! {
469     /// The `unfulfilled_lint_expectations` lint detects lint trigger expectations
470     /// that have not been fulfilled.
471     ///
472     /// ### Example
473     ///
474     /// ```rust
475     /// #![feature(lint_reasons)]
476     ///
477     /// #[expect(unused_variables)]
478     /// let x = 10;
479     /// println!("{}", x);
480     /// ```
481     ///
482     /// {{produces}}
483     ///
484     /// ### Explanation
485     ///
486     /// It was expected that the marked code would emit a lint. This expectation
487     /// has not been fulfilled.
488     ///
489     /// The `expect` attribute can be removed if this is intended behavior otherwise
490     /// it should be investigated why the expected lint is no longer issued.
491     ///
492     /// In rare cases, the expectation might be emitted at a different location than
493     /// shown in the shown code snippet. In most cases, the `#[expect]` attribute
494     /// works when added to the outer scope. A few lints can only be expected
495     /// on a crate level.
496     ///
497     /// Part of RFC 2383. The progress is being tracked in [#54503]
498     ///
499     /// [#54503]: https://github.com/rust-lang/rust/issues/54503
500     pub UNFULFILLED_LINT_EXPECTATIONS,
501     Warn,
502     "unfulfilled lint expectation",
503     @feature_gate = rustc_span::sym::lint_reasons;
504 }
505
506 declare_lint! {
507     /// The `unused_variables` lint detects variables which are not used in
508     /// any way.
509     ///
510     /// ### Example
511     ///
512     /// ```rust
513     /// let x = 5;
514     /// ```
515     ///
516     /// {{produces}}
517     ///
518     /// ### Explanation
519     ///
520     /// Unused variables may signal a mistake or unfinished code. To silence
521     /// the warning for the individual variable, prefix it with an underscore
522     /// such as `_x`.
523     pub UNUSED_VARIABLES,
524     Warn,
525     "detect variables which are not used in any way"
526 }
527
528 declare_lint! {
529     /// The `unused_assignments` lint detects assignments that will never be read.
530     ///
531     /// ### Example
532     ///
533     /// ```rust
534     /// let mut x = 5;
535     /// x = 6;
536     /// ```
537     ///
538     /// {{produces}}
539     ///
540     /// ### Explanation
541     ///
542     /// Unused assignments may signal a mistake or unfinished code. If the
543     /// variable is never used after being assigned, then the assignment can
544     /// be removed. Variables with an underscore prefix such as `_x` will not
545     /// trigger this lint.
546     pub UNUSED_ASSIGNMENTS,
547     Warn,
548     "detect assignments that will never be read"
549 }
550
551 declare_lint! {
552     /// The `dead_code` lint detects unused, unexported items.
553     ///
554     /// ### Example
555     ///
556     /// ```rust
557     /// fn foo() {}
558     /// ```
559     ///
560     /// {{produces}}
561     ///
562     /// ### Explanation
563     ///
564     /// Dead code may signal a mistake or unfinished code. To silence the
565     /// warning for individual items, prefix the name with an underscore such
566     /// as `_foo`. If it was intended to expose the item outside of the crate,
567     /// consider adding a visibility modifier like `pub`. Otherwise consider
568     /// removing the unused code.
569     pub DEAD_CODE,
570     Warn,
571     "detect unused, unexported items"
572 }
573
574 declare_lint! {
575     /// The `unused_attributes` lint detects attributes that were not used by
576     /// the compiler.
577     ///
578     /// ### Example
579     ///
580     /// ```rust
581     /// #![ignore]
582     /// ```
583     ///
584     /// {{produces}}
585     ///
586     /// ### Explanation
587     ///
588     /// Unused [attributes] may indicate the attribute is placed in the wrong
589     /// position. Consider removing it, or placing it in the correct position.
590     /// Also consider if you intended to use an _inner attribute_ (with a `!`
591     /// such as `#![allow(unused)]`) which applies to the item the attribute
592     /// is within, or an _outer attribute_ (without a `!` such as
593     /// `#[allow(unused)]`) which applies to the item *following* the
594     /// attribute.
595     ///
596     /// [attributes]: https://doc.rust-lang.org/reference/attributes.html
597     pub UNUSED_ATTRIBUTES,
598     Warn,
599     "detects attributes that were not used by the compiler"
600 }
601
602 declare_lint! {
603     /// The `unused_tuple_struct_fields` lint detects fields of tuple structs
604     /// that are never read.
605     ///
606     /// ### Example
607     ///
608     /// ```rust
609     /// #[warn(unused_tuple_struct_fields)]
610     /// struct S(i32, i32, i32);
611     /// let s = S(1, 2, 3);
612     /// let _ = (s.0, s.2);
613     /// ```
614     ///
615     /// {{produces}}
616     ///
617     /// ### Explanation
618     ///
619     /// Tuple struct fields that are never read anywhere may indicate a
620     /// mistake or unfinished code. To silence this warning, consider
621     /// removing the unused field(s) or, to preserve the numbering of the
622     /// remaining fields, change the unused field(s) to have unit type.
623     pub UNUSED_TUPLE_STRUCT_FIELDS,
624     Allow,
625     "detects tuple struct fields that are never read"
626 }
627
628 declare_lint! {
629     /// The `unreachable_code` lint detects unreachable code paths.
630     ///
631     /// ### Example
632     ///
633     /// ```rust,no_run
634     /// panic!("we never go past here!");
635     ///
636     /// let x = 5;
637     /// ```
638     ///
639     /// {{produces}}
640     ///
641     /// ### Explanation
642     ///
643     /// Unreachable code may signal a mistake or unfinished code. If the code
644     /// is no longer in use, consider removing it.
645     pub UNREACHABLE_CODE,
646     Warn,
647     "detects unreachable code paths",
648     report_in_external_macro
649 }
650
651 declare_lint! {
652     /// The `unreachable_patterns` lint detects unreachable patterns.
653     ///
654     /// ### Example
655     ///
656     /// ```rust
657     /// let x = 5;
658     /// match x {
659     ///     y => (),
660     ///     5 => (),
661     /// }
662     /// ```
663     ///
664     /// {{produces}}
665     ///
666     /// ### Explanation
667     ///
668     /// This usually indicates a mistake in how the patterns are specified or
669     /// ordered. In this example, the `y` pattern will always match, so the
670     /// five is impossible to reach. Remember, match arms match in order, you
671     /// probably wanted to put the `5` case above the `y` case.
672     pub UNREACHABLE_PATTERNS,
673     Warn,
674     "detects unreachable patterns"
675 }
676
677 declare_lint! {
678     /// The `overlapping_range_endpoints` lint detects `match` arms that have [range patterns] that
679     /// overlap on their endpoints.
680     ///
681     /// [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns
682     ///
683     /// ### Example
684     ///
685     /// ```rust
686     /// let x = 123u8;
687     /// match x {
688     ///     0..=100 => { println!("small"); }
689     ///     100..=255 => { println!("large"); }
690     /// }
691     /// ```
692     ///
693     /// {{produces}}
694     ///
695     /// ### Explanation
696     ///
697     /// It is likely a mistake to have range patterns in a match expression that overlap in this
698     /// way. Check that the beginning and end values are what you expect, and keep in mind that
699     /// with `..=` the left and right bounds are inclusive.
700     pub OVERLAPPING_RANGE_ENDPOINTS,
701     Warn,
702     "detects range patterns with overlapping endpoints"
703 }
704
705 declare_lint! {
706     /// The `bindings_with_variant_name` lint detects pattern bindings with
707     /// the same name as one of the matched variants.
708     ///
709     /// ### Example
710     ///
711     /// ```rust,compile_fail
712     /// pub enum Enum {
713     ///     Foo,
714     ///     Bar,
715     /// }
716     ///
717     /// pub fn foo(x: Enum) {
718     ///     match x {
719     ///         Foo => {}
720     ///         Bar => {}
721     ///     }
722     /// }
723     /// ```
724     ///
725     /// {{produces}}
726     ///
727     /// ### Explanation
728     ///
729     /// It is usually a mistake to specify an enum variant name as an
730     /// [identifier pattern]. In the example above, the `match` arms are
731     /// specifying a variable name to bind the value of `x` to. The second arm
732     /// is ignored because the first one matches *all* values. The likely
733     /// intent is that the arm was intended to match on the enum variant.
734     ///
735     /// Two possible solutions are:
736     ///
737     /// * Specify the enum variant using a [path pattern], such as
738     ///   `Enum::Foo`.
739     /// * Bring the enum variants into local scope, such as adding `use
740     ///   Enum::*;` to the beginning of the `foo` function in the example
741     ///   above.
742     ///
743     /// [identifier pattern]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
744     /// [path pattern]: https://doc.rust-lang.org/reference/patterns.html#path-patterns
745     pub BINDINGS_WITH_VARIANT_NAME,
746     Deny,
747     "detects pattern bindings with the same name as one of the matched variants"
748 }
749
750 declare_lint! {
751     /// The `unused_macros` lint detects macros that were not used.
752     ///
753     /// Note that this lint is distinct from the `unused_macro_rules` lint,
754     /// which checks for single rules that never match of an otherwise used
755     /// macro, and thus never expand.
756     ///
757     /// ### Example
758     ///
759     /// ```rust
760     /// macro_rules! unused {
761     ///     () => {};
762     /// }
763     ///
764     /// fn main() {
765     /// }
766     /// ```
767     ///
768     /// {{produces}}
769     ///
770     /// ### Explanation
771     ///
772     /// Unused macros may signal a mistake or unfinished code. To silence the
773     /// warning for the individual macro, prefix the name with an underscore
774     /// such as `_my_macro`. If you intended to export the macro to make it
775     /// available outside of the crate, use the [`macro_export` attribute].
776     ///
777     /// [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
778     pub UNUSED_MACROS,
779     Warn,
780     "detects macros that were not used"
781 }
782
783 declare_lint! {
784     /// The `unused_macro_rules` lint detects macro rules that were not used.
785     ///
786     /// Note that the lint is distinct from the `unused_macros` lint, which
787     /// fires if the entire macro is never called, while this lint fires for
788     /// single unused rules of the macro that is otherwise used.
789     /// `unused_macro_rules` fires only if `unused_macros` wouldn't fire.
790     ///
791     /// ### Example
792     ///
793     /// ```rust
794     /// #[warn(unused_macro_rules)]
795     /// macro_rules! unused_empty {
796     ///     (hello) => { println!("Hello, world!") }; // This rule is unused
797     ///     () => { println!("empty") }; // This rule is used
798     /// }
799     ///
800     /// fn main() {
801     ///     unused_empty!(hello);
802     /// }
803     /// ```
804     ///
805     /// {{produces}}
806     ///
807     /// ### Explanation
808     ///
809     /// Unused macro rules may signal a mistake or unfinished code. Furthermore,
810     /// they slow down compilation. Right now, silencing the warning is not
811     /// supported on a single rule level, so you have to add an allow to the
812     /// entire macro definition.
813     ///
814     /// If you intended to export the macro to make it
815     /// available outside of the crate, use the [`macro_export` attribute].
816     ///
817     /// [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
818     pub UNUSED_MACRO_RULES,
819     Allow,
820     "detects macro rules that were not used"
821 }
822
823 declare_lint! {
824     /// The `warnings` lint allows you to change the level of other
825     /// lints which produce warnings.
826     ///
827     /// ### Example
828     ///
829     /// ```rust
830     /// #![deny(warnings)]
831     /// fn foo() {}
832     /// ```
833     ///
834     /// {{produces}}
835     ///
836     /// ### Explanation
837     ///
838     /// The `warnings` lint is a bit special; by changing its level, you
839     /// change every other warning that would produce a warning to whatever
840     /// value you'd like. As such, you won't ever trigger this lint in your
841     /// code directly.
842     pub WARNINGS,
843     Warn,
844     "mass-change the level for lints which produce warnings"
845 }
846
847 declare_lint! {
848     /// The `unused_features` lint detects unused or unknown features found in
849     /// crate-level [`feature` attributes].
850     ///
851     /// [`feature` attributes]: https://doc.rust-lang.org/nightly/unstable-book/
852     ///
853     /// Note: This lint is currently not functional, see [issue #44232] for
854     /// more details.
855     ///
856     /// [issue #44232]: https://github.com/rust-lang/rust/issues/44232
857     pub UNUSED_FEATURES,
858     Warn,
859     "unused features found in crate-level `#[feature]` directives"
860 }
861
862 declare_lint! {
863     /// The `stable_features` lint detects a [`feature` attribute] that
864     /// has since been made stable.
865     ///
866     /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
867     ///
868     /// ### Example
869     ///
870     /// ```rust
871     /// #![feature(test_accepted_feature)]
872     /// fn main() {}
873     /// ```
874     ///
875     /// {{produces}}
876     ///
877     /// ### Explanation
878     ///
879     /// When a feature is stabilized, it is no longer necessary to include a
880     /// `#![feature]` attribute for it. To fix, simply remove the
881     /// `#![feature]` attribute.
882     pub STABLE_FEATURES,
883     Warn,
884     "stable features found in `#[feature]` directive"
885 }
886
887 declare_lint! {
888     /// The `unknown_crate_types` lint detects an unknown crate type found in
889     /// a [`crate_type` attribute].
890     ///
891     /// ### Example
892     ///
893     /// ```rust,compile_fail
894     /// #![crate_type="lol"]
895     /// fn main() {}
896     /// ```
897     ///
898     /// {{produces}}
899     ///
900     /// ### Explanation
901     ///
902     /// An unknown value give to the `crate_type` attribute is almost
903     /// certainly a mistake.
904     ///
905     /// [`crate_type` attribute]: https://doc.rust-lang.org/reference/linkage.html
906     pub UNKNOWN_CRATE_TYPES,
907     Deny,
908     "unknown crate type found in `#[crate_type]` directive",
909     crate_level_only
910 }
911
912 declare_lint! {
913     /// The `trivial_casts` lint detects trivial casts which could be replaced
914     /// with coercion, which may require a temporary variable.
915     ///
916     /// ### Example
917     ///
918     /// ```rust,compile_fail
919     /// #![deny(trivial_casts)]
920     /// let x: &u32 = &42;
921     /// let y = x as *const u32;
922     /// ```
923     ///
924     /// {{produces}}
925     ///
926     /// ### Explanation
927     ///
928     /// A trivial cast is a cast `e as T` where `e` has type `U` and `U` is a
929     /// subtype of `T`. This type of cast is usually unnecessary, as it can be
930     /// usually be inferred.
931     ///
932     /// This lint is "allow" by default because there are situations, such as
933     /// with FFI interfaces or complex type aliases, where it triggers
934     /// incorrectly, or in situations where it will be more difficult to
935     /// clearly express the intent. It may be possible that this will become a
936     /// warning in the future, possibly with an explicit syntax for coercions
937     /// providing a convenient way to work around the current issues.
938     /// See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and
939     /// [RFC 3307 (remove type ascription)][rfc-3307] for historical context.
940     ///
941     /// [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
942     /// [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md
943     /// [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md
944     pub TRIVIAL_CASTS,
945     Allow,
946     "detects trivial casts which could be removed"
947 }
948
949 declare_lint! {
950     /// The `trivial_numeric_casts` lint detects trivial numeric casts of types
951     /// which could be removed.
952     ///
953     /// ### Example
954     ///
955     /// ```rust,compile_fail
956     /// #![deny(trivial_numeric_casts)]
957     /// let x = 42_i32 as i32;
958     /// ```
959     ///
960     /// {{produces}}
961     ///
962     /// ### Explanation
963     ///
964     /// A trivial numeric cast is a cast of a numeric type to the same numeric
965     /// type. This type of cast is usually unnecessary.
966     ///
967     /// This lint is "allow" by default because there are situations, such as
968     /// with FFI interfaces or complex type aliases, where it triggers
969     /// incorrectly, or in situations where it will be more difficult to
970     /// clearly express the intent. It may be possible that this will become a
971     /// warning in the future, possibly with an explicit syntax for coercions
972     /// providing a convenient way to work around the current issues.
973     /// See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and
974     /// [RFC 3307 (remove type ascription)][rfc-3307] for historical context.
975     ///
976     /// [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
977     /// [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md
978     /// [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md
979     pub TRIVIAL_NUMERIC_CASTS,
980     Allow,
981     "detects trivial casts of numeric types which could be removed"
982 }
983
984 declare_lint! {
985     /// The `private_in_public` lint detects private items in public
986     /// interfaces not caught by the old implementation.
987     ///
988     /// ### Example
989     ///
990     /// ```rust
991     /// # #![allow(unused)]
992     /// struct SemiPriv;
993     ///
994     /// mod m1 {
995     ///     struct Priv;
996     ///     impl super::SemiPriv {
997     ///         pub fn f(_: Priv) {}
998     ///     }
999     /// }
1000     /// # fn main() {}
1001     /// ```
1002     ///
1003     /// {{produces}}
1004     ///
1005     /// ### Explanation
1006     ///
1007     /// The visibility rules are intended to prevent exposing private items in
1008     /// public interfaces. This is a [future-incompatible] lint to transition
1009     /// this to a hard error in the future. See [issue #34537] for more
1010     /// details.
1011     ///
1012     /// [issue #34537]: https://github.com/rust-lang/rust/issues/34537
1013     /// [future-incompatible]: ../index.md#future-incompatible-lints
1014     pub PRIVATE_IN_PUBLIC,
1015     Warn,
1016     "detect private items in public interfaces not caught by the old implementation",
1017     @future_incompatible = FutureIncompatibleInfo {
1018         reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
1019     };
1020 }
1021
1022 declare_lint! {
1023     /// The `invalid_alignment` lint detects dereferences of misaligned pointers during
1024     /// constant evluation.
1025     ///
1026     /// ### Example
1027     ///
1028     /// ```rust,compile_fail
1029     /// #![feature(const_ptr_read)]
1030     /// const FOO: () = unsafe {
1031     ///     let x = &[0_u8; 4];
1032     ///     let y = x.as_ptr().cast::<u32>();
1033     ///     y.read(); // the address of a `u8` array is unknown and thus we don't know if
1034     ///     // it is aligned enough for reading a `u32`.
1035     /// };
1036     /// ```
1037     ///
1038     /// {{produces}}
1039     ///
1040     /// ### Explanation
1041     ///
1042     /// The compiler allowed dereferencing raw pointers irrespective of alignment
1043     /// during const eval due to the const evaluator at the time not making it easy
1044     /// or cheap to check. Now that it is both, this is not accepted anymore.
1045     ///
1046     /// Since it was undefined behaviour to begin with, this breakage does not violate
1047     /// Rust's stability guarantees. Using undefined behaviour can cause arbitrary
1048     /// behaviour, including failure to build.
1049     ///
1050     /// [future-incompatible]: ../index.md#future-incompatible-lints
1051     pub INVALID_ALIGNMENT,
1052     Deny,
1053     "raw pointers must be aligned before dereferencing",
1054     @future_incompatible = FutureIncompatibleInfo {
1055         reference: "issue #68585 <https://github.com/rust-lang/rust/issues/104616>",
1056         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
1057     };
1058 }
1059
1060 declare_lint! {
1061     /// The `exported_private_dependencies` lint detects private dependencies
1062     /// that are exposed in a public interface.
1063     ///
1064     /// ### Example
1065     ///
1066     /// ```rust,ignore (needs-dependency)
1067     /// pub fn foo() -> Option<some_private_dependency::Thing> {
1068     ///     None
1069     /// }
1070     /// ```
1071     ///
1072     /// This will produce:
1073     ///
1074     /// ```text
1075     /// warning: type `bar::Thing` from private dependency 'bar' in public interface
1076     ///  --> src/lib.rs:3:1
1077     ///   |
1078     /// 3 | pub fn foo() -> Option<bar::Thing> {
1079     ///   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1080     ///   |
1081     ///   = note: `#[warn(exported_private_dependencies)]` on by default
1082     /// ```
1083     ///
1084     /// ### Explanation
1085     ///
1086     /// Dependencies can be marked as "private" to indicate that they are not
1087     /// exposed in the public interface of a crate. This can be used by Cargo
1088     /// to independently resolve those dependencies because it can assume it
1089     /// does not need to unify them with other packages using that same
1090     /// dependency. This lint is an indication of a violation of that
1091     /// contract.
1092     ///
1093     /// To fix this, avoid exposing the dependency in your public interface.
1094     /// Or, switch the dependency to a public dependency.
1095     ///
1096     /// Note that support for this is only available on the nightly channel.
1097     /// See [RFC 1977] for more details, as well as the [Cargo documentation].
1098     ///
1099     /// [RFC 1977]: https://github.com/rust-lang/rfcs/blob/master/text/1977-public-private-dependencies.md
1100     /// [Cargo documentation]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#public-dependency
1101     pub EXPORTED_PRIVATE_DEPENDENCIES,
1102     Warn,
1103     "public interface leaks type from a private dependency"
1104 }
1105
1106 declare_lint! {
1107     /// The `pub_use_of_private_extern_crate` lint detects a specific
1108     /// situation of re-exporting a private `extern crate`.
1109     ///
1110     /// ### Example
1111     ///
1112     /// ```rust,compile_fail
1113     /// extern crate core;
1114     /// pub use core as reexported_core;
1115     /// ```
1116     ///
1117     /// {{produces}}
1118     ///
1119     /// ### Explanation
1120     ///
1121     /// A public `use` declaration should not be used to publicly re-export a
1122     /// private `extern crate`. `pub extern crate` should be used instead.
1123     ///
1124     /// This was historically allowed, but is not the intended behavior
1125     /// according to the visibility rules. This is a [future-incompatible]
1126     /// lint to transition this to a hard error in the future. See [issue
1127     /// #34537] for more details.
1128     ///
1129     /// [issue #34537]: https://github.com/rust-lang/rust/issues/34537
1130     /// [future-incompatible]: ../index.md#future-incompatible-lints
1131     pub PUB_USE_OF_PRIVATE_EXTERN_CRATE,
1132     Deny,
1133     "detect public re-exports of private extern crates",
1134     @future_incompatible = FutureIncompatibleInfo {
1135         reference: "issue #34537 <https://github.com/rust-lang/rust/issues/34537>",
1136     };
1137 }
1138
1139 declare_lint! {
1140     /// The `invalid_type_param_default` lint detects type parameter defaults
1141     /// erroneously allowed in an invalid location.
1142     ///
1143     /// ### Example
1144     ///
1145     /// ```rust,compile_fail
1146     /// fn foo<T=i32>(t: T) {}
1147     /// ```
1148     ///
1149     /// {{produces}}
1150     ///
1151     /// ### Explanation
1152     ///
1153     /// Default type parameters were only intended to be allowed in certain
1154     /// situations, but historically the compiler allowed them everywhere.
1155     /// This is a [future-incompatible] lint to transition this to a hard
1156     /// error in the future. See [issue #36887] for more details.
1157     ///
1158     /// [issue #36887]: https://github.com/rust-lang/rust/issues/36887
1159     /// [future-incompatible]: ../index.md#future-incompatible-lints
1160     pub INVALID_TYPE_PARAM_DEFAULT,
1161     Deny,
1162     "type parameter default erroneously allowed in invalid location",
1163     @future_incompatible = FutureIncompatibleInfo {
1164         reference: "issue #36887 <https://github.com/rust-lang/rust/issues/36887>",
1165     };
1166 }
1167
1168 declare_lint! {
1169     /// The `renamed_and_removed_lints` lint detects lints that have been
1170     /// renamed or removed.
1171     ///
1172     /// ### Example
1173     ///
1174     /// ```rust
1175     /// #![deny(raw_pointer_derive)]
1176     /// ```
1177     ///
1178     /// {{produces}}
1179     ///
1180     /// ### Explanation
1181     ///
1182     /// To fix this, either remove the lint or use the new name. This can help
1183     /// avoid confusion about lints that are no longer valid, and help
1184     /// maintain consistency for renamed lints.
1185     pub RENAMED_AND_REMOVED_LINTS,
1186     Warn,
1187     "lints that have been renamed or removed"
1188 }
1189
1190 declare_lint! {
1191     /// The `const_item_mutation` lint detects attempts to mutate a `const`
1192     /// item.
1193     ///
1194     /// ### Example
1195     ///
1196     /// ```rust
1197     /// const FOO: [i32; 1] = [0];
1198     ///
1199     /// fn main() {
1200     ///     FOO[0] = 1;
1201     ///     // This will print "[0]".
1202     ///     println!("{:?}", FOO);
1203     /// }
1204     /// ```
1205     ///
1206     /// {{produces}}
1207     ///
1208     /// ### Explanation
1209     ///
1210     /// Trying to directly mutate a `const` item is almost always a mistake.
1211     /// What is happening in the example above is that a temporary copy of the
1212     /// `const` is mutated, but the original `const` is not. Each time you
1213     /// refer to the `const` by name (such as `FOO` in the example above), a
1214     /// separate copy of the value is inlined at that location.
1215     ///
1216     /// This lint checks for writing directly to a field (`FOO.field =
1217     /// some_value`) or array entry (`FOO[0] = val`), or taking a mutable
1218     /// reference to the const item (`&mut FOO`), including through an
1219     /// autoderef (`FOO.some_mut_self_method()`).
1220     ///
1221     /// There are various alternatives depending on what you are trying to
1222     /// accomplish:
1223     ///
1224     /// * First, always reconsider using mutable globals, as they can be
1225     ///   difficult to use correctly, and can make the code more difficult to
1226     ///   use or understand.
1227     /// * If you are trying to perform a one-time initialization of a global:
1228     ///     * If the value can be computed at compile-time, consider using
1229     ///       const-compatible values (see [Constant Evaluation]).
1230     ///     * For more complex single-initialization cases, consider using a
1231     ///       third-party crate, such as [`lazy_static`] or [`once_cell`].
1232     ///     * If you are using the [nightly channel], consider the new
1233     ///       [`lazy`] module in the standard library.
1234     /// * If you truly need a mutable global, consider using a [`static`],
1235     ///   which has a variety of options:
1236     ///   * Simple data types can be directly defined and mutated with an
1237     ///     [`atomic`] type.
1238     ///   * More complex types can be placed in a synchronization primitive
1239     ///     like a [`Mutex`], which can be initialized with one of the options
1240     ///     listed above.
1241     ///   * A [mutable `static`] is a low-level primitive, requiring unsafe.
1242     ///     Typically This should be avoided in preference of something
1243     ///     higher-level like one of the above.
1244     ///
1245     /// [Constant Evaluation]: https://doc.rust-lang.org/reference/const_eval.html
1246     /// [`static`]: https://doc.rust-lang.org/reference/items/static-items.html
1247     /// [mutable `static`]: https://doc.rust-lang.org/reference/items/static-items.html#mutable-statics
1248     /// [`lazy`]: https://doc.rust-lang.org/nightly/std/lazy/index.html
1249     /// [`lazy_static`]: https://crates.io/crates/lazy_static
1250     /// [`once_cell`]: https://crates.io/crates/once_cell
1251     /// [`atomic`]: https://doc.rust-lang.org/std/sync/atomic/index.html
1252     /// [`Mutex`]: https://doc.rust-lang.org/std/sync/struct.Mutex.html
1253     pub CONST_ITEM_MUTATION,
1254     Warn,
1255     "detects attempts to mutate a `const` item",
1256 }
1257
1258 declare_lint! {
1259     /// The `patterns_in_fns_without_body` lint detects `mut` identifier
1260     /// patterns as a parameter in functions without a body.
1261     ///
1262     /// ### Example
1263     ///
1264     /// ```rust,compile_fail
1265     /// trait Trait {
1266     ///     fn foo(mut arg: u8);
1267     /// }
1268     /// ```
1269     ///
1270     /// {{produces}}
1271     ///
1272     /// ### Explanation
1273     ///
1274     /// To fix this, remove `mut` from the parameter in the trait definition;
1275     /// it can be used in the implementation. That is, the following is OK:
1276     ///
1277     /// ```rust
1278     /// trait Trait {
1279     ///     fn foo(arg: u8); // Removed `mut` here
1280     /// }
1281     ///
1282     /// impl Trait for i32 {
1283     ///     fn foo(mut arg: u8) { // `mut` here is OK
1284     ///
1285     ///     }
1286     /// }
1287     /// ```
1288     ///
1289     /// Trait definitions can define functions without a body to specify a
1290     /// function that implementors must define. The parameter names in the
1291     /// body-less functions are only allowed to be `_` or an [identifier] for
1292     /// documentation purposes (only the type is relevant). Previous versions
1293     /// of the compiler erroneously allowed [identifier patterns] with the
1294     /// `mut` keyword, but this was not intended to be allowed. This is a
1295     /// [future-incompatible] lint to transition this to a hard error in the
1296     /// future. See [issue #35203] for more details.
1297     ///
1298     /// [identifier]: https://doc.rust-lang.org/reference/identifiers.html
1299     /// [identifier patterns]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
1300     /// [issue #35203]: https://github.com/rust-lang/rust/issues/35203
1301     /// [future-incompatible]: ../index.md#future-incompatible-lints
1302     pub PATTERNS_IN_FNS_WITHOUT_BODY,
1303     Deny,
1304     "patterns in functions without body were erroneously allowed",
1305     @future_incompatible = FutureIncompatibleInfo {
1306         reference: "issue #35203 <https://github.com/rust-lang/rust/issues/35203>",
1307     };
1308 }
1309
1310 declare_lint! {
1311     /// The `missing_fragment_specifier` lint is issued when an unused pattern in a
1312     /// `macro_rules!` macro definition has a meta-variable (e.g. `$e`) that is not
1313     /// followed by a fragment specifier (e.g. `:expr`).
1314     ///
1315     /// This warning can always be fixed by removing the unused pattern in the
1316     /// `macro_rules!` macro definition.
1317     ///
1318     /// ### Example
1319     ///
1320     /// ```rust,compile_fail
1321     /// macro_rules! foo {
1322     ///    () => {};
1323     ///    ($name) => { };
1324     /// }
1325     ///
1326     /// fn main() {
1327     ///    foo!();
1328     /// }
1329     /// ```
1330     ///
1331     /// {{produces}}
1332     ///
1333     /// ### Explanation
1334     ///
1335     /// To fix this, remove the unused pattern from the `macro_rules!` macro definition:
1336     ///
1337     /// ```rust
1338     /// macro_rules! foo {
1339     ///     () => {};
1340     /// }
1341     /// fn main() {
1342     ///     foo!();
1343     /// }
1344     /// ```
1345     pub MISSING_FRAGMENT_SPECIFIER,
1346     Deny,
1347     "detects missing fragment specifiers in unused `macro_rules!` patterns",
1348     @future_incompatible = FutureIncompatibleInfo {
1349         reference: "issue #40107 <https://github.com/rust-lang/rust/issues/40107>",
1350     };
1351 }
1352
1353 declare_lint! {
1354     /// The `late_bound_lifetime_arguments` lint detects generic lifetime
1355     /// arguments in path segments with late bound lifetime parameters.
1356     ///
1357     /// ### Example
1358     ///
1359     /// ```rust
1360     /// struct S;
1361     ///
1362     /// impl S {
1363     ///     fn late(self, _: &u8, _: &u8) {}
1364     /// }
1365     ///
1366     /// fn main() {
1367     ///     S.late::<'static>(&0, &0);
1368     /// }
1369     /// ```
1370     ///
1371     /// {{produces}}
1372     ///
1373     /// ### Explanation
1374     ///
1375     /// It is not clear how to provide arguments for early-bound lifetime
1376     /// parameters if they are intermixed with late-bound parameters in the
1377     /// same list. For now, providing any explicit arguments will trigger this
1378     /// lint if late-bound parameters are present, so in the future a solution
1379     /// can be adopted without hitting backward compatibility issues. This is
1380     /// a [future-incompatible] lint to transition this to a hard error in the
1381     /// future. See [issue #42868] for more details, along with a description
1382     /// of the difference between early and late-bound parameters.
1383     ///
1384     /// [issue #42868]: https://github.com/rust-lang/rust/issues/42868
1385     /// [future-incompatible]: ../index.md#future-incompatible-lints
1386     pub LATE_BOUND_LIFETIME_ARGUMENTS,
1387     Warn,
1388     "detects generic lifetime arguments in path segments with late bound lifetime parameters",
1389     @future_incompatible = FutureIncompatibleInfo {
1390         reference: "issue #42868 <https://github.com/rust-lang/rust/issues/42868>",
1391     };
1392 }
1393
1394 declare_lint! {
1395     /// The `order_dependent_trait_objects` lint detects a trait coherency
1396     /// violation that would allow creating two trait impls for the same
1397     /// dynamic trait object involving marker traits.
1398     ///
1399     /// ### Example
1400     ///
1401     /// ```rust,compile_fail
1402     /// pub trait Trait {}
1403     ///
1404     /// impl Trait for dyn Send + Sync { }
1405     /// impl Trait for dyn Sync + Send { }
1406     /// ```
1407     ///
1408     /// {{produces}}
1409     ///
1410     /// ### Explanation
1411     ///
1412     /// A previous bug caused the compiler to interpret traits with different
1413     /// orders (such as `Send + Sync` and `Sync + Send`) as distinct types
1414     /// when they were intended to be treated the same. This allowed code to
1415     /// define separate trait implementations when there should be a coherence
1416     /// error. This is a [future-incompatible] lint to transition this to a
1417     /// hard error in the future. See [issue #56484] for more details.
1418     ///
1419     /// [issue #56484]: https://github.com/rust-lang/rust/issues/56484
1420     /// [future-incompatible]: ../index.md#future-incompatible-lints
1421     pub ORDER_DEPENDENT_TRAIT_OBJECTS,
1422     Deny,
1423     "trait-object types were treated as different depending on marker-trait order",
1424     @future_incompatible = FutureIncompatibleInfo {
1425         reference: "issue #56484 <https://github.com/rust-lang/rust/issues/56484>",
1426         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
1427     };
1428 }
1429
1430 declare_lint! {
1431     /// The `coherence_leak_check` lint detects conflicting implementations of
1432     /// a trait that are only distinguished by the old leak-check code.
1433     ///
1434     /// ### Example
1435     ///
1436     /// ```rust
1437     /// trait SomeTrait { }
1438     /// impl SomeTrait for for<'a> fn(&'a u8) { }
1439     /// impl<'a> SomeTrait for fn(&'a u8) { }
1440     /// ```
1441     ///
1442     /// {{produces}}
1443     ///
1444     /// ### Explanation
1445     ///
1446     /// In the past, the compiler would accept trait implementations for
1447     /// identical functions that differed only in where the lifetime binder
1448     /// appeared. Due to a change in the borrow checker implementation to fix
1449     /// several bugs, this is no longer allowed. However, since this affects
1450     /// existing code, this is a [future-incompatible] lint to transition this
1451     /// to a hard error in the future.
1452     ///
1453     /// Code relying on this pattern should introduce "[newtypes]",
1454     /// like `struct Foo(for<'a> fn(&'a u8))`.
1455     ///
1456     /// See [issue #56105] for more details.
1457     ///
1458     /// [issue #56105]: https://github.com/rust-lang/rust/issues/56105
1459     /// [newtypes]: https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction
1460     /// [future-incompatible]: ../index.md#future-incompatible-lints
1461     pub COHERENCE_LEAK_CHECK,
1462     Warn,
1463     "distinct impls distinguished only by the leak-check code",
1464     @future_incompatible = FutureIncompatibleInfo {
1465         reference: "issue #56105 <https://github.com/rust-lang/rust/issues/56105>",
1466     };
1467 }
1468
1469 declare_lint! {
1470     /// The `deprecated` lint detects use of deprecated items.
1471     ///
1472     /// ### Example
1473     ///
1474     /// ```rust
1475     /// #[deprecated]
1476     /// fn foo() {}
1477     ///
1478     /// fn bar() {
1479     ///     foo();
1480     /// }
1481     /// ```
1482     ///
1483     /// {{produces}}
1484     ///
1485     /// ### Explanation
1486     ///
1487     /// Items may be marked "deprecated" with the [`deprecated` attribute] to
1488     /// indicate that they should no longer be used. Usually the attribute
1489     /// should include a note on what to use instead, or check the
1490     /// documentation.
1491     ///
1492     /// [`deprecated` attribute]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute
1493     pub DEPRECATED,
1494     Warn,
1495     "detects use of deprecated items",
1496     report_in_external_macro
1497 }
1498
1499 declare_lint! {
1500     /// The `unused_unsafe` lint detects unnecessary use of an `unsafe` block.
1501     ///
1502     /// ### Example
1503     ///
1504     /// ```rust
1505     /// unsafe {}
1506     /// ```
1507     ///
1508     /// {{produces}}
1509     ///
1510     /// ### Explanation
1511     ///
1512     /// If nothing within the block requires `unsafe`, then remove the
1513     /// `unsafe` marker because it is not required and may cause confusion.
1514     pub UNUSED_UNSAFE,
1515     Warn,
1516     "unnecessary use of an `unsafe` block"
1517 }
1518
1519 declare_lint! {
1520     /// The `unused_mut` lint detects mut variables which don't need to be
1521     /// mutable.
1522     ///
1523     /// ### Example
1524     ///
1525     /// ```rust
1526     /// let mut x = 5;
1527     /// ```
1528     ///
1529     /// {{produces}}
1530     ///
1531     /// ### Explanation
1532     ///
1533     /// The preferred style is to only mark variables as `mut` if it is
1534     /// required.
1535     pub UNUSED_MUT,
1536     Warn,
1537     "detect mut variables which don't need to be mutable"
1538 }
1539
1540 declare_lint! {
1541     /// The `unconditional_recursion` lint detects functions that cannot
1542     /// return without calling themselves.
1543     ///
1544     /// ### Example
1545     ///
1546     /// ```rust
1547     /// fn foo() {
1548     ///     foo();
1549     /// }
1550     /// ```
1551     ///
1552     /// {{produces}}
1553     ///
1554     /// ### Explanation
1555     ///
1556     /// It is usually a mistake to have a recursive call that does not have
1557     /// some condition to cause it to terminate. If you really intend to have
1558     /// an infinite loop, using a `loop` expression is recommended.
1559     pub UNCONDITIONAL_RECURSION,
1560     Warn,
1561     "functions that cannot return without calling themselves"
1562 }
1563
1564 declare_lint! {
1565     /// The `single_use_lifetimes` lint detects lifetimes that are only used
1566     /// once.
1567     ///
1568     /// ### Example
1569     ///
1570     /// ```rust,compile_fail
1571     /// #![deny(single_use_lifetimes)]
1572     ///
1573     /// fn foo<'a>(x: &'a u32) {}
1574     /// ```
1575     ///
1576     /// {{produces}}
1577     ///
1578     /// ### Explanation
1579     ///
1580     /// Specifying an explicit lifetime like `'a` in a function or `impl`
1581     /// should only be used to link together two things. Otherwise, you should
1582     /// just use `'_` to indicate that the lifetime is not linked to anything,
1583     /// or elide the lifetime altogether if possible.
1584     ///
1585     /// This lint is "allow" by default because it was introduced at a time
1586     /// when `'_` and elided lifetimes were first being introduced, and this
1587     /// lint would be too noisy. Also, there are some known false positives
1588     /// that it produces. See [RFC 2115] for historical context, and [issue
1589     /// #44752] for more details.
1590     ///
1591     /// [RFC 2115]: https://github.com/rust-lang/rfcs/blob/master/text/2115-argument-lifetimes.md
1592     /// [issue #44752]: https://github.com/rust-lang/rust/issues/44752
1593     pub SINGLE_USE_LIFETIMES,
1594     Allow,
1595     "detects lifetime parameters that are only used once"
1596 }
1597
1598 declare_lint! {
1599     /// The `unused_lifetimes` lint detects lifetime parameters that are never
1600     /// used.
1601     ///
1602     /// ### Example
1603     ///
1604     /// ```rust,compile_fail
1605     /// #[deny(unused_lifetimes)]
1606     ///
1607     /// pub fn foo<'a>() {}
1608     /// ```
1609     ///
1610     /// {{produces}}
1611     ///
1612     /// ### Explanation
1613     ///
1614     /// Unused lifetime parameters may signal a mistake or unfinished code.
1615     /// Consider removing the parameter.
1616     pub UNUSED_LIFETIMES,
1617     Allow,
1618     "detects lifetime parameters that are never used"
1619 }
1620
1621 declare_lint! {
1622     /// The `tyvar_behind_raw_pointer` lint detects raw pointer to an
1623     /// inference variable.
1624     ///
1625     /// ### Example
1626     ///
1627     /// ```rust,edition2015
1628     /// // edition 2015
1629     /// let data = std::ptr::null();
1630     /// let _ = &data as *const *const ();
1631     ///
1632     /// if data.is_null() {}
1633     /// ```
1634     ///
1635     /// {{produces}}
1636     ///
1637     /// ### Explanation
1638     ///
1639     /// This kind of inference was previously allowed, but with the future
1640     /// arrival of [arbitrary self types], this can introduce ambiguity. To
1641     /// resolve this, use an explicit type instead of relying on type
1642     /// inference.
1643     ///
1644     /// This is a [future-incompatible] lint to transition this to a hard
1645     /// error in the 2018 edition. See [issue #46906] for more details. This
1646     /// is currently a hard-error on the 2018 edition, and is "warn" by
1647     /// default in the 2015 edition.
1648     ///
1649     /// [arbitrary self types]: https://github.com/rust-lang/rust/issues/44874
1650     /// [issue #46906]: https://github.com/rust-lang/rust/issues/46906
1651     /// [future-incompatible]: ../index.md#future-incompatible-lints
1652     pub TYVAR_BEHIND_RAW_POINTER,
1653     Warn,
1654     "raw pointer to an inference variable",
1655     @future_incompatible = FutureIncompatibleInfo {
1656         reference: "issue #46906 <https://github.com/rust-lang/rust/issues/46906>",
1657         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2018),
1658     };
1659 }
1660
1661 declare_lint! {
1662     /// The `elided_lifetimes_in_paths` lint detects the use of hidden
1663     /// lifetime parameters.
1664     ///
1665     /// ### Example
1666     ///
1667     /// ```rust,compile_fail
1668     /// #![deny(elided_lifetimes_in_paths)]
1669     /// struct Foo<'a> {
1670     ///     x: &'a u32
1671     /// }
1672     ///
1673     /// fn foo(x: &Foo) {
1674     /// }
1675     /// ```
1676     ///
1677     /// {{produces}}
1678     ///
1679     /// ### Explanation
1680     ///
1681     /// Elided lifetime parameters can make it difficult to see at a glance
1682     /// that borrowing is occurring. This lint ensures that lifetime
1683     /// parameters are always explicitly stated, even if it is the `'_`
1684     /// [placeholder lifetime].
1685     ///
1686     /// This lint is "allow" by default because it has some known issues, and
1687     /// may require a significant transition for old code.
1688     ///
1689     /// [placeholder lifetime]: https://doc.rust-lang.org/reference/lifetime-elision.html#lifetime-elision-in-functions
1690     pub ELIDED_LIFETIMES_IN_PATHS,
1691     Allow,
1692     "hidden lifetime parameters in types are deprecated",
1693     crate_level_only
1694 }
1695
1696 declare_lint! {
1697     /// The `bare_trait_objects` lint suggests using `dyn Trait` for trait
1698     /// objects.
1699     ///
1700     /// ### Example
1701     ///
1702     /// ```rust,edition2018
1703     /// trait Trait { }
1704     ///
1705     /// fn takes_trait_object(_: Box<Trait>) {
1706     /// }
1707     /// ```
1708     ///
1709     /// {{produces}}
1710     ///
1711     /// ### Explanation
1712     ///
1713     /// Without the `dyn` indicator, it can be ambiguous or confusing when
1714     /// reading code as to whether or not you are looking at a trait object.
1715     /// The `dyn` keyword makes it explicit, and adds a symmetry to contrast
1716     /// with [`impl Trait`].
1717     ///
1718     /// [`impl Trait`]: https://doc.rust-lang.org/book/ch10-02-traits.html#traits-as-parameters
1719     pub BARE_TRAIT_OBJECTS,
1720     Warn,
1721     "suggest using `dyn Trait` for trait objects",
1722     @future_incompatible = FutureIncompatibleInfo {
1723         reference: "<https://doc.rust-lang.org/nightly/edition-guide/rust-2021/warnings-promoted-to-error.html>",
1724         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2021),
1725     };
1726 }
1727
1728 declare_lint! {
1729     /// The `absolute_paths_not_starting_with_crate` lint detects fully
1730     /// qualified paths that start with a module name instead of `crate`,
1731     /// `self`, or an extern crate name
1732     ///
1733     /// ### Example
1734     ///
1735     /// ```rust,edition2015,compile_fail
1736     /// #![deny(absolute_paths_not_starting_with_crate)]
1737     ///
1738     /// mod foo {
1739     ///     pub fn bar() {}
1740     /// }
1741     ///
1742     /// fn main() {
1743     ///     ::foo::bar();
1744     /// }
1745     /// ```
1746     ///
1747     /// {{produces}}
1748     ///
1749     /// ### Explanation
1750     ///
1751     /// Rust [editions] allow the language to evolve without breaking
1752     /// backwards compatibility. This lint catches code that uses absolute
1753     /// paths in the style of the 2015 edition. In the 2015 edition, absolute
1754     /// paths (those starting with `::`) refer to either the crate root or an
1755     /// external crate. In the 2018 edition it was changed so that they only
1756     /// refer to external crates. The path prefix `crate::` should be used
1757     /// instead to reference items from the crate root.
1758     ///
1759     /// If you switch the compiler from the 2015 to 2018 edition without
1760     /// updating the code, then it will fail to compile if the old style paths
1761     /// are used. You can manually change the paths to use the `crate::`
1762     /// prefix to transition to the 2018 edition.
1763     ///
1764     /// This lint solves the problem automatically. It is "allow" by default
1765     /// because the code is perfectly valid in the 2015 edition. The [`cargo
1766     /// fix`] tool with the `--edition` flag will switch this lint to "warn"
1767     /// and automatically apply the suggested fix from the compiler. This
1768     /// provides a completely automated way to update old code to the 2018
1769     /// edition.
1770     ///
1771     /// [editions]: https://doc.rust-lang.org/edition-guide/
1772     /// [`cargo fix`]: https://doc.rust-lang.org/cargo/commands/cargo-fix.html
1773     pub ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
1774     Allow,
1775     "fully qualified paths that start with a module name \
1776      instead of `crate`, `self`, or an extern crate name",
1777      @future_incompatible = FutureIncompatibleInfo {
1778         reference: "issue #53130 <https://github.com/rust-lang/rust/issues/53130>",
1779         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2018),
1780      };
1781 }
1782
1783 declare_lint! {
1784     /// The `illegal_floating_point_literal_pattern` lint detects
1785     /// floating-point literals used in patterns.
1786     ///
1787     /// ### Example
1788     ///
1789     /// ```rust
1790     /// let x = 42.0;
1791     ///
1792     /// match x {
1793     ///     5.0 => {}
1794     ///     _ => {}
1795     /// }
1796     /// ```
1797     ///
1798     /// {{produces}}
1799     ///
1800     /// ### Explanation
1801     ///
1802     /// Previous versions of the compiler accepted floating-point literals in
1803     /// patterns, but it was later determined this was a mistake. The
1804     /// semantics of comparing floating-point values may not be clear in a
1805     /// pattern when contrasted with "structural equality". Typically you can
1806     /// work around this by using a [match guard], such as:
1807     ///
1808     /// ```rust
1809     /// # let x = 42.0;
1810     ///
1811     /// match x {
1812     ///     y if y == 5.0 => {}
1813     ///     _ => {}
1814     /// }
1815     /// ```
1816     ///
1817     /// This is a [future-incompatible] lint to transition this to a hard
1818     /// error in the future. See [issue #41620] for more details.
1819     ///
1820     /// [issue #41620]: https://github.com/rust-lang/rust/issues/41620
1821     /// [match guard]: https://doc.rust-lang.org/reference/expressions/match-expr.html#match-guards
1822     /// [future-incompatible]: ../index.md#future-incompatible-lints
1823     pub ILLEGAL_FLOATING_POINT_LITERAL_PATTERN,
1824     Warn,
1825     "floating-point literals cannot be used in patterns",
1826     @future_incompatible = FutureIncompatibleInfo {
1827         reference: "issue #41620 <https://github.com/rust-lang/rust/issues/41620>",
1828     };
1829 }
1830
1831 declare_lint! {
1832     /// The `unstable_name_collisions` lint detects that you have used a name
1833     /// that the standard library plans to add in the future.
1834     ///
1835     /// ### Example
1836     ///
1837     /// ```rust
1838     /// trait MyIterator : Iterator {
1839     ///     // is_sorted is an unstable method that already exists on the Iterator trait
1840     ///     fn is_sorted(self) -> bool where Self: Sized {true}
1841     /// }
1842     ///
1843     /// impl<T: ?Sized> MyIterator for T where T: Iterator { }
1844     ///
1845     /// let x = vec![1, 2, 3];
1846     /// let _ = x.iter().is_sorted();
1847     /// ```
1848     ///
1849     /// {{produces}}
1850     ///
1851     /// ### Explanation
1852     ///
1853     /// When new methods are added to traits in the standard library, they are
1854     /// usually added in an "unstable" form which is only available on the
1855     /// [nightly channel] with a [`feature` attribute]. If there is any
1856     /// pre-existing code which extends a trait to have a method with the same
1857     /// name, then the names will collide. In the future, when the method is
1858     /// stabilized, this will cause an error due to the ambiguity. This lint
1859     /// is an early-warning to let you know that there may be a collision in
1860     /// the future. This can be avoided by adding type annotations to
1861     /// disambiguate which trait method you intend to call, such as
1862     /// `MyIterator::is_sorted(my_iter)` or renaming or removing the method.
1863     ///
1864     /// [nightly channel]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
1865     /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
1866     pub UNSTABLE_NAME_COLLISIONS,
1867     Warn,
1868     "detects name collision with an existing but unstable method",
1869     @future_incompatible = FutureIncompatibleInfo {
1870         reason: FutureIncompatibilityReason::Custom(
1871             "once this associated item is added to the standard library, \
1872              the ambiguity may cause an error or change in behavior!"
1873         ),
1874         reference: "issue #48919 <https://github.com/rust-lang/rust/issues/48919>",
1875         // Note: this item represents future incompatibility of all unstable functions in the
1876         //       standard library, and thus should never be removed or changed to an error.
1877     };
1878 }
1879
1880 declare_lint! {
1881     /// The `irrefutable_let_patterns` lint detects [irrefutable patterns]
1882     /// in [`if let`]s, [`while let`]s, and `if let` guards.
1883     ///
1884     /// ### Example
1885     ///
1886     /// ```rust
1887     /// if let _ = 123 {
1888     ///     println!("always runs!");
1889     /// }
1890     /// ```
1891     ///
1892     /// {{produces}}
1893     ///
1894     /// ### Explanation
1895     ///
1896     /// There usually isn't a reason to have an irrefutable pattern in an
1897     /// `if let` or `while let` statement, because the pattern will always match
1898     /// successfully. A [`let`] or [`loop`] statement will suffice. However,
1899     /// when generating code with a macro, forbidding irrefutable patterns
1900     /// would require awkward workarounds in situations where the macro
1901     /// doesn't know if the pattern is refutable or not. This lint allows
1902     /// macros to accept this form, while alerting for a possibly incorrect
1903     /// use in normal code.
1904     ///
1905     /// See [RFC 2086] for more details.
1906     ///
1907     /// [irrefutable patterns]: https://doc.rust-lang.org/reference/patterns.html#refutability
1908     /// [`if let`]: https://doc.rust-lang.org/reference/expressions/if-expr.html#if-let-expressions
1909     /// [`while let`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#predicate-pattern-loops
1910     /// [`let`]: https://doc.rust-lang.org/reference/statements.html#let-statements
1911     /// [`loop`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#infinite-loops
1912     /// [RFC 2086]: https://github.com/rust-lang/rfcs/blob/master/text/2086-allow-if-let-irrefutables.md
1913     pub IRREFUTABLE_LET_PATTERNS,
1914     Warn,
1915     "detects irrefutable patterns in `if let` and `while let` statements"
1916 }
1917
1918 declare_lint! {
1919     /// The `unused_labels` lint detects [labels] that are never used.
1920     ///
1921     /// [labels]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#loop-labels
1922     ///
1923     /// ### Example
1924     ///
1925     /// ```rust,no_run
1926     /// 'unused_label: loop {}
1927     /// ```
1928     ///
1929     /// {{produces}}
1930     ///
1931     /// ### Explanation
1932     ///
1933     /// Unused labels may signal a mistake or unfinished code. To silence the
1934     /// warning for the individual label, prefix it with an underscore such as
1935     /// `'_my_label:`.
1936     pub UNUSED_LABELS,
1937     Warn,
1938     "detects labels that are never used"
1939 }
1940
1941 declare_lint! {
1942     /// The `where_clauses_object_safety` lint detects for [object safety] of
1943     /// [where clauses].
1944     ///
1945     /// [object safety]: https://doc.rust-lang.org/reference/items/traits.html#object-safety
1946     /// [where clauses]: https://doc.rust-lang.org/reference/items/generics.html#where-clauses
1947     ///
1948     /// ### Example
1949     ///
1950     /// ```rust,no_run
1951     /// trait Trait {}
1952     ///
1953     /// trait X { fn foo(&self) where Self: Trait; }
1954     ///
1955     /// impl X for () { fn foo(&self) {} }
1956     ///
1957     /// impl Trait for dyn X {}
1958     ///
1959     /// // Segfault at opt-level 0, SIGILL otherwise.
1960     /// pub fn main() { <dyn X as X>::foo(&()); }
1961     /// ```
1962     ///
1963     /// {{produces}}
1964     ///
1965     /// ### Explanation
1966     ///
1967     /// The compiler previously allowed these object-unsafe bounds, which was
1968     /// incorrect. This is a [future-incompatible] lint to transition this to
1969     /// a hard error in the future. See [issue #51443] for more details.
1970     ///
1971     /// [issue #51443]: https://github.com/rust-lang/rust/issues/51443
1972     /// [future-incompatible]: ../index.md#future-incompatible-lints
1973     pub WHERE_CLAUSES_OBJECT_SAFETY,
1974     Warn,
1975     "checks the object safety of where clauses",
1976     @future_incompatible = FutureIncompatibleInfo {
1977         reference: "issue #51443 <https://github.com/rust-lang/rust/issues/51443>",
1978     };
1979 }
1980
1981 declare_lint! {
1982     /// The `proc_macro_derive_resolution_fallback` lint detects proc macro
1983     /// derives using inaccessible names from parent modules.
1984     ///
1985     /// ### Example
1986     ///
1987     /// ```rust,ignore (proc-macro)
1988     /// // foo.rs
1989     /// #![crate_type = "proc-macro"]
1990     ///
1991     /// extern crate proc_macro;
1992     ///
1993     /// use proc_macro::*;
1994     ///
1995     /// #[proc_macro_derive(Foo)]
1996     /// pub fn foo1(a: TokenStream) -> TokenStream {
1997     ///     drop(a);
1998     ///     "mod __bar { static mut BAR: Option<Something> = None; }".parse().unwrap()
1999     /// }
2000     /// ```
2001     ///
2002     /// ```rust,ignore (needs-dependency)
2003     /// // bar.rs
2004     /// #[macro_use]
2005     /// extern crate foo;
2006     ///
2007     /// struct Something;
2008     ///
2009     /// #[derive(Foo)]
2010     /// struct Another;
2011     ///
2012     /// fn main() {}
2013     /// ```
2014     ///
2015     /// This will produce:
2016     ///
2017     /// ```text
2018     /// warning: cannot find type `Something` in this scope
2019     ///  --> src/main.rs:8:10
2020     ///   |
2021     /// 8 | #[derive(Foo)]
2022     ///   |          ^^^ names from parent modules are not accessible without an explicit import
2023     ///   |
2024     ///   = note: `#[warn(proc_macro_derive_resolution_fallback)]` on by default
2025     ///   = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
2026     ///   = note: for more information, see issue #50504 <https://github.com/rust-lang/rust/issues/50504>
2027     /// ```
2028     ///
2029     /// ### Explanation
2030     ///
2031     /// If a proc-macro generates a module, the compiler unintentionally
2032     /// allowed items in that module to refer to items in the crate root
2033     /// without importing them. This is a [future-incompatible] lint to
2034     /// transition this to a hard error in the future. See [issue #50504] for
2035     /// more details.
2036     ///
2037     /// [issue #50504]: https://github.com/rust-lang/rust/issues/50504
2038     /// [future-incompatible]: ../index.md#future-incompatible-lints
2039     pub PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
2040     Deny,
2041     "detects proc macro derives using inaccessible names from parent modules",
2042     @future_incompatible = FutureIncompatibleInfo {
2043         reference: "issue #83583 <https://github.com/rust-lang/rust/issues/83583>",
2044         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
2045     };
2046 }
2047
2048 declare_lint! {
2049     /// The `macro_use_extern_crate` lint detects the use of the
2050     /// [`macro_use` attribute].
2051     ///
2052     /// ### Example
2053     ///
2054     /// ```rust,ignore (needs extern crate)
2055     /// #![deny(macro_use_extern_crate)]
2056     ///
2057     /// #[macro_use]
2058     /// extern crate serde_json;
2059     ///
2060     /// fn main() {
2061     ///     let _ = json!{{}};
2062     /// }
2063     /// ```
2064     ///
2065     /// This will produce:
2066     ///
2067     /// ```text
2068     /// error: deprecated `#[macro_use]` attribute used to import macros should be replaced at use sites with a `use` item to import the macro instead
2069     ///  --> src/main.rs:3:1
2070     ///   |
2071     /// 3 | #[macro_use]
2072     ///   | ^^^^^^^^^^^^
2073     ///   |
2074     /// note: the lint level is defined here
2075     ///  --> src/main.rs:1:9
2076     ///   |
2077     /// 1 | #![deny(macro_use_extern_crate)]
2078     ///   |         ^^^^^^^^^^^^^^^^^^^^^^
2079     /// ```
2080     ///
2081     /// ### Explanation
2082     ///
2083     /// The [`macro_use` attribute] on an [`extern crate`] item causes
2084     /// macros in that external crate to be brought into the prelude of the
2085     /// crate, making the macros in scope everywhere. As part of the efforts
2086     /// to simplify handling of dependencies in the [2018 edition], the use of
2087     /// `extern crate` is being phased out. To bring macros from extern crates
2088     /// into scope, it is recommended to use a [`use` import].
2089     ///
2090     /// This lint is "allow" by default because this is a stylistic choice
2091     /// that has not been settled, see [issue #52043] for more information.
2092     ///
2093     /// [`macro_use` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#the-macro_use-attribute
2094     /// [`use` import]: https://doc.rust-lang.org/reference/items/use-declarations.html
2095     /// [issue #52043]: https://github.com/rust-lang/rust/issues/52043
2096     pub MACRO_USE_EXTERN_CRATE,
2097     Allow,
2098     "the `#[macro_use]` attribute is now deprecated in favor of using macros \
2099      via the module system"
2100 }
2101
2102 declare_lint! {
2103     /// The `macro_expanded_macro_exports_accessed_by_absolute_paths` lint
2104     /// detects macro-expanded [`macro_export`] macros from the current crate
2105     /// that cannot be referred to by absolute paths.
2106     ///
2107     /// [`macro_export`]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
2108     ///
2109     /// ### Example
2110     ///
2111     /// ```rust,compile_fail
2112     /// macro_rules! define_exported {
2113     ///     () => {
2114     ///         #[macro_export]
2115     ///         macro_rules! exported {
2116     ///             () => {};
2117     ///         }
2118     ///     };
2119     /// }
2120     ///
2121     /// define_exported!();
2122     ///
2123     /// fn main() {
2124     ///     crate::exported!();
2125     /// }
2126     /// ```
2127     ///
2128     /// {{produces}}
2129     ///
2130     /// ### Explanation
2131     ///
2132     /// The intent is that all macros marked with the `#[macro_export]`
2133     /// attribute are made available in the root of the crate. However, when a
2134     /// `macro_rules!` definition is generated by another macro, the macro
2135     /// expansion is unable to uphold this rule. This is a
2136     /// [future-incompatible] lint to transition this to a hard error in the
2137     /// future. See [issue #53495] for more details.
2138     ///
2139     /// [issue #53495]: https://github.com/rust-lang/rust/issues/53495
2140     /// [future-incompatible]: ../index.md#future-incompatible-lints
2141     pub MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2142     Deny,
2143     "macro-expanded `macro_export` macros from the current crate \
2144      cannot be referred to by absolute paths",
2145     @future_incompatible = FutureIncompatibleInfo {
2146         reference: "issue #52234 <https://github.com/rust-lang/rust/issues/52234>",
2147     };
2148     crate_level_only
2149 }
2150
2151 declare_lint! {
2152     /// The `explicit_outlives_requirements` lint detects unnecessary
2153     /// lifetime bounds that can be inferred.
2154     ///
2155     /// ### Example
2156     ///
2157     /// ```rust,compile_fail
2158     /// # #![allow(unused)]
2159     /// #![deny(explicit_outlives_requirements)]
2160     ///
2161     /// struct SharedRef<'a, T>
2162     /// where
2163     ///     T: 'a,
2164     /// {
2165     ///     data: &'a T,
2166     /// }
2167     /// ```
2168     ///
2169     /// {{produces}}
2170     ///
2171     /// ### Explanation
2172     ///
2173     /// If a `struct` contains a reference, such as `&'a T`, the compiler
2174     /// requires that `T` outlives the lifetime `'a`. This historically
2175     /// required writing an explicit lifetime bound to indicate this
2176     /// requirement. However, this can be overly explicit, causing clutter and
2177     /// unnecessary complexity. The language was changed to automatically
2178     /// infer the bound if it is not specified. Specifically, if the struct
2179     /// contains a reference, directly or indirectly, to `T` with lifetime
2180     /// `'x`, then it will infer that `T: 'x` is a requirement.
2181     ///
2182     /// This lint is "allow" by default because it can be noisy for existing
2183     /// code that already had these requirements. This is a stylistic choice,
2184     /// as it is still valid to explicitly state the bound. It also has some
2185     /// false positives that can cause confusion.
2186     ///
2187     /// See [RFC 2093] for more details.
2188     ///
2189     /// [RFC 2093]: https://github.com/rust-lang/rfcs/blob/master/text/2093-infer-outlives.md
2190     pub EXPLICIT_OUTLIVES_REQUIREMENTS,
2191     Allow,
2192     "outlives requirements can be inferred"
2193 }
2194
2195 declare_lint! {
2196     /// The `indirect_structural_match` lint detects a `const` in a pattern
2197     /// that manually implements [`PartialEq`] and [`Eq`].
2198     ///
2199     /// [`PartialEq`]: https://doc.rust-lang.org/std/cmp/trait.PartialEq.html
2200     /// [`Eq`]: https://doc.rust-lang.org/std/cmp/trait.Eq.html
2201     ///
2202     /// ### Example
2203     ///
2204     /// ```rust,compile_fail
2205     /// #![deny(indirect_structural_match)]
2206     ///
2207     /// struct NoDerive(i32);
2208     /// impl PartialEq for NoDerive { fn eq(&self, _: &Self) -> bool { false } }
2209     /// impl Eq for NoDerive { }
2210     /// #[derive(PartialEq, Eq)]
2211     /// struct WrapParam<T>(T);
2212     /// const WRAP_INDIRECT_PARAM: & &WrapParam<NoDerive> = & &WrapParam(NoDerive(0));
2213     /// fn main() {
2214     ///     match WRAP_INDIRECT_PARAM {
2215     ///         WRAP_INDIRECT_PARAM => { }
2216     ///         _ => { }
2217     ///     }
2218     /// }
2219     /// ```
2220     ///
2221     /// {{produces}}
2222     ///
2223     /// ### Explanation
2224     ///
2225     /// The compiler unintentionally accepted this form in the past. This is a
2226     /// [future-incompatible] lint to transition this to a hard error in the
2227     /// future. See [issue #62411] for a complete description of the problem,
2228     /// and some possible solutions.
2229     ///
2230     /// [issue #62411]: https://github.com/rust-lang/rust/issues/62411
2231     /// [future-incompatible]: ../index.md#future-incompatible-lints
2232     pub INDIRECT_STRUCTURAL_MATCH,
2233     Warn,
2234     "constant used in pattern contains value of non-structural-match type in a field or a variant",
2235     @future_incompatible = FutureIncompatibleInfo {
2236         reference: "issue #62411 <https://github.com/rust-lang/rust/issues/62411>",
2237     };
2238 }
2239
2240 declare_lint! {
2241     /// The `deprecated_in_future` lint is internal to rustc and should not be
2242     /// used by user code.
2243     ///
2244     /// This lint is only enabled in the standard library. It works with the
2245     /// use of `#[deprecated]` with a `since` field of a version in the future.
2246     /// This allows something to be marked as deprecated in a future version,
2247     /// and then this lint will ensure that the item is no longer used in the
2248     /// standard library. See the [stability documentation] for more details.
2249     ///
2250     /// [stability documentation]: https://rustc-dev-guide.rust-lang.org/stability.html#deprecated
2251     pub DEPRECATED_IN_FUTURE,
2252     Allow,
2253     "detects use of items that will be deprecated in a future version",
2254     report_in_external_macro
2255 }
2256
2257 declare_lint! {
2258     /// The `pointer_structural_match` lint detects pointers used in patterns whose behaviour
2259     /// cannot be relied upon across compiler versions and optimization levels.
2260     ///
2261     /// ### Example
2262     ///
2263     /// ```rust,compile_fail
2264     /// #![deny(pointer_structural_match)]
2265     /// fn foo(a: usize, b: usize) -> usize { a + b }
2266     /// const FOO: fn(usize, usize) -> usize = foo;
2267     /// fn main() {
2268     ///     match FOO {
2269     ///         FOO => {},
2270     ///         _ => {},
2271     ///     }
2272     /// }
2273     /// ```
2274     ///
2275     /// {{produces}}
2276     ///
2277     /// ### Explanation
2278     ///
2279     /// Previous versions of Rust allowed function pointers and wide raw pointers in patterns.
2280     /// While these work in many cases as expected by users, it is possible that due to
2281     /// optimizations pointers are "not equal to themselves" or pointers to different functions
2282     /// compare as equal during runtime. This is because LLVM optimizations can deduplicate
2283     /// functions if their bodies are the same, thus also making pointers to these functions point
2284     /// to the same location. Additionally functions may get duplicated if they are instantiated
2285     /// in different crates and not deduplicated again via LTO.
2286     pub POINTER_STRUCTURAL_MATCH,
2287     Allow,
2288     "pointers are not structural-match",
2289     @future_incompatible = FutureIncompatibleInfo {
2290         reference: "issue #62411 <https://github.com/rust-lang/rust/issues/70861>",
2291     };
2292 }
2293
2294 declare_lint! {
2295     /// The `nontrivial_structural_match` lint detects constants that are used in patterns,
2296     /// whose type is not structural-match and whose initializer body actually uses values
2297     /// that are not structural-match. So `Option<NotStructuralMatch>` is ok if the constant
2298     /// is just `None`.
2299     ///
2300     /// ### Example
2301     ///
2302     /// ```rust,compile_fail
2303     /// #![deny(nontrivial_structural_match)]
2304     ///
2305     /// #[derive(Copy, Clone, Debug)]
2306     /// struct NoDerive(u32);
2307     /// impl PartialEq for NoDerive { fn eq(&self, _: &Self) -> bool { false } }
2308     /// impl Eq for NoDerive { }
2309     /// fn main() {
2310     ///     const INDEX: Option<NoDerive> = [None, Some(NoDerive(10))][0];
2311     ///     match None { Some(_) => panic!("whoops"), INDEX => dbg!(INDEX), };
2312     /// }
2313     /// ```
2314     ///
2315     /// {{produces}}
2316     ///
2317     /// ### Explanation
2318     ///
2319     /// Previous versions of Rust accepted constants in patterns, even if those constants' types
2320     /// did not have `PartialEq` derived. Thus the compiler falls back to runtime execution of
2321     /// `PartialEq`, which can report that two constants are not equal even if they are
2322     /// bit-equivalent.
2323     pub NONTRIVIAL_STRUCTURAL_MATCH,
2324     Warn,
2325     "constant used in pattern of non-structural-match type and the constant's initializer \
2326     expression contains values of non-structural-match types",
2327     @future_incompatible = FutureIncompatibleInfo {
2328         reference: "issue #73448 <https://github.com/rust-lang/rust/issues/73448>",
2329     };
2330 }
2331
2332 declare_lint! {
2333     /// The `ambiguous_associated_items` lint detects ambiguity between
2334     /// [associated items] and [enum variants].
2335     ///
2336     /// [associated items]: https://doc.rust-lang.org/reference/items/associated-items.html
2337     /// [enum variants]: https://doc.rust-lang.org/reference/items/enumerations.html
2338     ///
2339     /// ### Example
2340     ///
2341     /// ```rust,compile_fail
2342     /// enum E {
2343     ///     V
2344     /// }
2345     ///
2346     /// trait Tr {
2347     ///     type V;
2348     ///     fn foo() -> Self::V;
2349     /// }
2350     ///
2351     /// impl Tr for E {
2352     ///     type V = u8;
2353     ///     // `Self::V` is ambiguous because it may refer to the associated type or
2354     ///     // the enum variant.
2355     ///     fn foo() -> Self::V { 0 }
2356     /// }
2357     /// ```
2358     ///
2359     /// {{produces}}
2360     ///
2361     /// ### Explanation
2362     ///
2363     /// Previous versions of Rust did not allow accessing enum variants
2364     /// through [type aliases]. When this ability was added (see [RFC 2338]), this
2365     /// introduced some situations where it can be ambiguous what a type
2366     /// was referring to.
2367     ///
2368     /// To fix this ambiguity, you should use a [qualified path] to explicitly
2369     /// state which type to use. For example, in the above example the
2370     /// function can be written as `fn f() -> <Self as Tr>::V { 0 }` to
2371     /// specifically refer to the associated type.
2372     ///
2373     /// This is a [future-incompatible] lint to transition this to a hard
2374     /// error in the future. See [issue #57644] for more details.
2375     ///
2376     /// [issue #57644]: https://github.com/rust-lang/rust/issues/57644
2377     /// [type aliases]: https://doc.rust-lang.org/reference/items/type-aliases.html#type-aliases
2378     /// [RFC 2338]: https://github.com/rust-lang/rfcs/blob/master/text/2338-type-alias-enum-variants.md
2379     /// [qualified path]: https://doc.rust-lang.org/reference/paths.html#qualified-paths
2380     /// [future-incompatible]: ../index.md#future-incompatible-lints
2381     pub AMBIGUOUS_ASSOCIATED_ITEMS,
2382     Deny,
2383     "ambiguous associated items",
2384     @future_incompatible = FutureIncompatibleInfo {
2385         reference: "issue #57644 <https://github.com/rust-lang/rust/issues/57644>",
2386     };
2387 }
2388
2389 declare_lint! {
2390     /// The `soft_unstable` lint detects unstable features that were
2391     /// unintentionally allowed on stable.
2392     ///
2393     /// ### Example
2394     ///
2395     /// ```rust,compile_fail
2396     /// #[cfg(test)]
2397     /// extern crate test;
2398     ///
2399     /// #[bench]
2400     /// fn name(b: &mut test::Bencher) {
2401     ///     b.iter(|| 123)
2402     /// }
2403     /// ```
2404     ///
2405     /// {{produces}}
2406     ///
2407     /// ### Explanation
2408     ///
2409     /// The [`bench` attribute] was accidentally allowed to be specified on
2410     /// the [stable release channel]. Turning this to a hard error would have
2411     /// broken some projects. This lint allows those projects to continue to
2412     /// build correctly when [`--cap-lints`] is used, but otherwise signal an
2413     /// error that `#[bench]` should not be used on the stable channel. This
2414     /// is a [future-incompatible] lint to transition this to a hard error in
2415     /// the future. See [issue #64266] for more details.
2416     ///
2417     /// [issue #64266]: https://github.com/rust-lang/rust/issues/64266
2418     /// [`bench` attribute]: https://doc.rust-lang.org/nightly/unstable-book/library-features/test.html
2419     /// [stable release channel]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
2420     /// [`--cap-lints`]: https://doc.rust-lang.org/rustc/lints/levels.html#capping-lints
2421     /// [future-incompatible]: ../index.md#future-incompatible-lints
2422     pub SOFT_UNSTABLE,
2423     Deny,
2424     "a feature gate that doesn't break dependent crates",
2425     @future_incompatible = FutureIncompatibleInfo {
2426         reference: "issue #64266 <https://github.com/rust-lang/rust/issues/64266>",
2427     };
2428 }
2429
2430 declare_lint! {
2431     /// The `inline_no_sanitize` lint detects incompatible use of
2432     /// [`#[inline(always)]`][inline] and [`#[no_sanitize(...)]`][no_sanitize].
2433     ///
2434     /// [inline]: https://doc.rust-lang.org/reference/attributes/codegen.html#the-inline-attribute
2435     /// [no_sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html
2436     ///
2437     /// ### Example
2438     ///
2439     /// ```rust
2440     /// #![feature(no_sanitize)]
2441     ///
2442     /// #[inline(always)]
2443     /// #[no_sanitize(address)]
2444     /// fn x() {}
2445     ///
2446     /// fn main() {
2447     ///     x()
2448     /// }
2449     /// ```
2450     ///
2451     /// {{produces}}
2452     ///
2453     /// ### Explanation
2454     ///
2455     /// The use of the [`#[inline(always)]`][inline] attribute prevents the
2456     /// the [`#[no_sanitize(...)]`][no_sanitize] attribute from working.
2457     /// Consider temporarily removing `inline` attribute.
2458     pub INLINE_NO_SANITIZE,
2459     Warn,
2460     "detects incompatible use of `#[inline(always)]` and `#[no_sanitize(...)]`",
2461 }
2462
2463 declare_lint! {
2464     /// The `asm_sub_register` lint detects using only a subset of a register
2465     /// for inline asm inputs.
2466     ///
2467     /// ### Example
2468     ///
2469     /// ```rust,ignore (fails on non-x86_64)
2470     /// #[cfg(target_arch="x86_64")]
2471     /// use std::arch::asm;
2472     ///
2473     /// fn main() {
2474     ///     #[cfg(target_arch="x86_64")]
2475     ///     unsafe {
2476     ///         asm!("mov {0}, {0}", in(reg) 0i16);
2477     ///     }
2478     /// }
2479     /// ```
2480     ///
2481     /// This will produce:
2482     ///
2483     /// ```text
2484     /// warning: formatting may not be suitable for sub-register argument
2485     ///  --> src/main.rs:7:19
2486     ///   |
2487     /// 7 |         asm!("mov {0}, {0}", in(reg) 0i16);
2488     ///   |                   ^^^  ^^^           ---- for this argument
2489     ///   |
2490     ///   = note: `#[warn(asm_sub_register)]` on by default
2491     ///   = help: use the `x` modifier to have the register formatted as `ax`
2492     ///   = help: or use the `r` modifier to keep the default formatting of `rax`
2493     /// ```
2494     ///
2495     /// ### Explanation
2496     ///
2497     /// Registers on some architectures can use different names to refer to a
2498     /// subset of the register. By default, the compiler will use the name for
2499     /// the full register size. To explicitly use a subset of the register,
2500     /// you can override the default by using a modifier on the template
2501     /// string operand to specify when subregister to use. This lint is issued
2502     /// if you pass in a value with a smaller data type than the default
2503     /// register size, to alert you of possibly using the incorrect width. To
2504     /// fix this, add the suggested modifier to the template, or cast the
2505     /// value to the correct size.
2506     ///
2507     /// See [register template modifiers] in the reference for more details.
2508     ///
2509     /// [register template modifiers]: https://doc.rust-lang.org/nightly/reference/inline-assembly.html#template-modifiers
2510     pub ASM_SUB_REGISTER,
2511     Warn,
2512     "using only a subset of a register for inline asm inputs",
2513 }
2514
2515 declare_lint! {
2516     /// The `bad_asm_style` lint detects the use of the `.intel_syntax` and
2517     /// `.att_syntax` directives.
2518     ///
2519     /// ### Example
2520     ///
2521     /// ```rust,ignore (fails on non-x86_64)
2522     /// #[cfg(target_arch="x86_64")]
2523     /// use std::arch::asm;
2524     ///
2525     /// fn main() {
2526     ///     #[cfg(target_arch="x86_64")]
2527     ///     unsafe {
2528     ///         asm!(
2529     ///             ".att_syntax",
2530     ///             "movq %{0}, %{0}", in(reg) 0usize
2531     ///         );
2532     ///     }
2533     /// }
2534     /// ```
2535     ///
2536     /// This will produce:
2537     ///
2538     /// ```text
2539     /// warning: avoid using `.att_syntax`, prefer using `options(att_syntax)` instead
2540     ///  --> src/main.rs:8:14
2541     ///   |
2542     /// 8 |             ".att_syntax",
2543     ///   |              ^^^^^^^^^^^
2544     ///   |
2545     ///   = note: `#[warn(bad_asm_style)]` on by default
2546     /// ```
2547     ///
2548     /// ### Explanation
2549     ///
2550     /// On x86, `asm!` uses the intel assembly syntax by default. While this
2551     /// can be switched using assembler directives like `.att_syntax`, using the
2552     /// `att_syntax` option is recommended instead because it will also properly
2553     /// prefix register placeholders with `%` as required by AT&T syntax.
2554     pub BAD_ASM_STYLE,
2555     Warn,
2556     "incorrect use of inline assembly",
2557 }
2558
2559 declare_lint! {
2560     /// The `unsafe_op_in_unsafe_fn` lint detects unsafe operations in unsafe
2561     /// functions without an explicit unsafe block.
2562     ///
2563     /// ### Example
2564     ///
2565     /// ```rust,compile_fail
2566     /// #![deny(unsafe_op_in_unsafe_fn)]
2567     ///
2568     /// unsafe fn foo() {}
2569     ///
2570     /// unsafe fn bar() {
2571     ///     foo();
2572     /// }
2573     ///
2574     /// fn main() {}
2575     /// ```
2576     ///
2577     /// {{produces}}
2578     ///
2579     /// ### Explanation
2580     ///
2581     /// Currently, an [`unsafe fn`] allows any [unsafe] operation within its
2582     /// body. However, this can increase the surface area of code that needs
2583     /// to be scrutinized for proper behavior. The [`unsafe` block] provides a
2584     /// convenient way to make it clear exactly which parts of the code are
2585     /// performing unsafe operations. In the future, it is desired to change
2586     /// it so that unsafe operations cannot be performed in an `unsafe fn`
2587     /// without an `unsafe` block.
2588     ///
2589     /// The fix to this is to wrap the unsafe code in an `unsafe` block.
2590     ///
2591     /// This lint is "allow" by default since this will affect a large amount
2592     /// of existing code, and the exact plan for increasing the severity is
2593     /// still being considered. See [RFC #2585] and [issue #71668] for more
2594     /// details.
2595     ///
2596     /// [`unsafe fn`]: https://doc.rust-lang.org/reference/unsafe-functions.html
2597     /// [`unsafe` block]: https://doc.rust-lang.org/reference/expressions/block-expr.html#unsafe-blocks
2598     /// [unsafe]: https://doc.rust-lang.org/reference/unsafety.html
2599     /// [RFC #2585]: https://github.com/rust-lang/rfcs/blob/master/text/2585-unsafe-block-in-unsafe-fn.md
2600     /// [issue #71668]: https://github.com/rust-lang/rust/issues/71668
2601     pub UNSAFE_OP_IN_UNSAFE_FN,
2602     Allow,
2603     "unsafe operations in unsafe functions without an explicit unsafe block are deprecated",
2604 }
2605
2606 declare_lint! {
2607     /// The `cenum_impl_drop_cast` lint detects an `as` cast of a field-less
2608     /// `enum` that implements [`Drop`].
2609     ///
2610     /// [`Drop`]: https://doc.rust-lang.org/std/ops/trait.Drop.html
2611     ///
2612     /// ### Example
2613     ///
2614     /// ```rust,compile_fail
2615     /// # #![allow(unused)]
2616     /// enum E {
2617     ///     A,
2618     /// }
2619     ///
2620     /// impl Drop for E {
2621     ///     fn drop(&mut self) {
2622     ///         println!("Drop");
2623     ///     }
2624     /// }
2625     ///
2626     /// fn main() {
2627     ///     let e = E::A;
2628     ///     let i = e as u32;
2629     /// }
2630     /// ```
2631     ///
2632     /// {{produces}}
2633     ///
2634     /// ### Explanation
2635     ///
2636     /// Casting a field-less `enum` that does not implement [`Copy`] to an
2637     /// integer moves the value without calling `drop`. This can result in
2638     /// surprising behavior if it was expected that `drop` should be called.
2639     /// Calling `drop` automatically would be inconsistent with other move
2640     /// operations. Since neither behavior is clear or consistent, it was
2641     /// decided that a cast of this nature will no longer be allowed.
2642     ///
2643     /// This is a [future-incompatible] lint to transition this to a hard error
2644     /// in the future. See [issue #73333] for more details.
2645     ///
2646     /// [future-incompatible]: ../index.md#future-incompatible-lints
2647     /// [issue #73333]: https://github.com/rust-lang/rust/issues/73333
2648     /// [`Copy`]: https://doc.rust-lang.org/std/marker/trait.Copy.html
2649     pub CENUM_IMPL_DROP_CAST,
2650     Deny,
2651     "a C-like enum implementing Drop is cast",
2652     @future_incompatible = FutureIncompatibleInfo {
2653         reference: "issue #73333 <https://github.com/rust-lang/rust/issues/73333>",
2654         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
2655     };
2656 }
2657
2658 declare_lint! {
2659     /// The `fuzzy_provenance_casts` lint detects an `as` cast between an integer
2660     /// and a pointer.
2661     ///
2662     /// ### Example
2663     ///
2664     /// ```rust
2665     /// #![feature(strict_provenance)]
2666     /// #![warn(fuzzy_provenance_casts)]
2667     ///
2668     /// fn main() {
2669     ///     let _dangling = 16_usize as *const u8;
2670     /// }
2671     /// ```
2672     ///
2673     /// {{produces}}
2674     ///
2675     /// ### Explanation
2676     ///
2677     /// This lint is part of the strict provenance effort, see [issue #95228].
2678     /// Casting an integer to a pointer is considered bad style, as a pointer
2679     /// contains, besides the *address* also a *provenance*, indicating what
2680     /// memory the pointer is allowed to read/write. Casting an integer, which
2681     /// doesn't have provenance, to a pointer requires the compiler to assign
2682     /// (guess) provenance. The compiler assigns "all exposed valid" (see the
2683     /// docs of [`ptr::from_exposed_addr`] for more information about this
2684     /// "exposing"). This penalizes the optimiser and is not well suited for
2685     /// dynamic analysis/dynamic program verification (e.g. Miri or CHERI
2686     /// platforms).
2687     ///
2688     /// It is much better to use [`ptr::with_addr`] instead to specify the
2689     /// provenance you want. If using this function is not possible because the
2690     /// code relies on exposed provenance then there is as an escape hatch
2691     /// [`ptr::from_exposed_addr`].
2692     ///
2693     /// [issue #95228]: https://github.com/rust-lang/rust/issues/95228
2694     /// [`ptr::with_addr`]: https://doc.rust-lang.org/core/ptr/fn.with_addr
2695     /// [`ptr::from_exposed_addr`]: https://doc.rust-lang.org/core/ptr/fn.from_exposed_addr
2696     pub FUZZY_PROVENANCE_CASTS,
2697     Allow,
2698     "a fuzzy integer to pointer cast is used",
2699     @feature_gate = sym::strict_provenance;
2700 }
2701
2702 declare_lint! {
2703     /// The `lossy_provenance_casts` lint detects an `as` cast between a pointer
2704     /// and an integer.
2705     ///
2706     /// ### Example
2707     ///
2708     /// ```rust
2709     /// #![feature(strict_provenance)]
2710     /// #![warn(lossy_provenance_casts)]
2711     ///
2712     /// fn main() {
2713     ///     let x: u8 = 37;
2714     ///     let _addr: usize = &x as *const u8 as usize;
2715     /// }
2716     /// ```
2717     ///
2718     /// {{produces}}
2719     ///
2720     /// ### Explanation
2721     ///
2722     /// This lint is part of the strict provenance effort, see [issue #95228].
2723     /// Casting a pointer to an integer is a lossy operation, because beyond
2724     /// just an *address* a pointer may be associated with a particular
2725     /// *provenance*. This information is used by the optimiser and for dynamic
2726     /// analysis/dynamic program verification (e.g. Miri or CHERI platforms).
2727     ///
2728     /// Since this cast is lossy, it is considered good style to use the
2729     /// [`ptr::addr`] method instead, which has a similar effect, but doesn't
2730     /// "expose" the pointer provenance. This improves optimisation potential.
2731     /// See the docs of [`ptr::addr`] and [`ptr::expose_addr`] for more information
2732     /// about exposing pointer provenance.
2733     ///
2734     /// If your code can't comply with strict provenance and needs to expose
2735     /// the provenance, then there is [`ptr::expose_addr`] as an escape hatch,
2736     /// which preserves the behaviour of `as usize` casts while being explicit
2737     /// about the semantics.
2738     ///
2739     /// [issue #95228]: https://github.com/rust-lang/rust/issues/95228
2740     /// [`ptr::addr`]: https://doc.rust-lang.org/core/ptr/fn.addr
2741     /// [`ptr::expose_addr`]: https://doc.rust-lang.org/core/ptr/fn.expose_addr
2742     pub LOSSY_PROVENANCE_CASTS,
2743     Allow,
2744     "a lossy pointer to integer cast is used",
2745     @feature_gate = sym::strict_provenance;
2746 }
2747
2748 declare_lint! {
2749     /// The `const_evaluatable_unchecked` lint detects a generic constant used
2750     /// in a type.
2751     ///
2752     /// ### Example
2753     ///
2754     /// ```rust
2755     /// const fn foo<T>() -> usize {
2756     ///     if std::mem::size_of::<*mut T>() < 8 { // size of *mut T does not depend on T
2757     ///         4
2758     ///     } else {
2759     ///         8
2760     ///     }
2761     /// }
2762     ///
2763     /// fn test<T>() {
2764     ///     let _ = [0; foo::<T>()];
2765     /// }
2766     /// ```
2767     ///
2768     /// {{produces}}
2769     ///
2770     /// ### Explanation
2771     ///
2772     /// In the 1.43 release, some uses of generic parameters in array repeat
2773     /// expressions were accidentally allowed. This is a [future-incompatible]
2774     /// lint to transition this to a hard error in the future. See [issue
2775     /// #76200] for a more detailed description and possible fixes.
2776     ///
2777     /// [future-incompatible]: ../index.md#future-incompatible-lints
2778     /// [issue #76200]: https://github.com/rust-lang/rust/issues/76200
2779     pub CONST_EVALUATABLE_UNCHECKED,
2780     Warn,
2781     "detects a generic constant is used in a type without a emitting a warning",
2782     @future_incompatible = FutureIncompatibleInfo {
2783         reference: "issue #76200 <https://github.com/rust-lang/rust/issues/76200>",
2784     };
2785 }
2786
2787 declare_lint! {
2788     /// The `function_item_references` lint detects function references that are
2789     /// formatted with [`fmt::Pointer`] or transmuted.
2790     ///
2791     /// [`fmt::Pointer`]: https://doc.rust-lang.org/std/fmt/trait.Pointer.html
2792     ///
2793     /// ### Example
2794     ///
2795     /// ```rust
2796     /// fn foo() { }
2797     ///
2798     /// fn main() {
2799     ///     println!("{:p}", &foo);
2800     /// }
2801     /// ```
2802     ///
2803     /// {{produces}}
2804     ///
2805     /// ### Explanation
2806     ///
2807     /// Taking a reference to a function may be mistaken as a way to obtain a
2808     /// pointer to that function. This can give unexpected results when
2809     /// formatting the reference as a pointer or transmuting it. This lint is
2810     /// issued when function references are formatted as pointers, passed as
2811     /// arguments bound by [`fmt::Pointer`] or transmuted.
2812     pub FUNCTION_ITEM_REFERENCES,
2813     Warn,
2814     "suggest casting to a function pointer when attempting to take references to function items",
2815 }
2816
2817 declare_lint! {
2818     /// The `uninhabited_static` lint detects uninhabited statics.
2819     ///
2820     /// ### Example
2821     ///
2822     /// ```rust
2823     /// enum Void {}
2824     /// extern {
2825     ///     static EXTERN: Void;
2826     /// }
2827     /// ```
2828     ///
2829     /// {{produces}}
2830     ///
2831     /// ### Explanation
2832     ///
2833     /// Statics with an uninhabited type can never be initialized, so they are impossible to define.
2834     /// However, this can be side-stepped with an `extern static`, leading to problems later in the
2835     /// compiler which assumes that there are no initialized uninhabited places (such as locals or
2836     /// statics). This was accidentally allowed, but is being phased out.
2837     pub UNINHABITED_STATIC,
2838     Warn,
2839     "uninhabited static",
2840     @future_incompatible = FutureIncompatibleInfo {
2841         reference: "issue #74840 <https://github.com/rust-lang/rust/issues/74840>",
2842     };
2843 }
2844
2845 declare_lint! {
2846     /// The `useless_deprecated` lint detects deprecation attributes with no effect.
2847     ///
2848     /// ### Example
2849     ///
2850     /// ```rust,compile_fail
2851     /// struct X;
2852     ///
2853     /// #[deprecated = "message"]
2854     /// impl Default for X {
2855     ///     fn default() -> Self {
2856     ///         X
2857     ///     }
2858     /// }
2859     /// ```
2860     ///
2861     /// {{produces}}
2862     ///
2863     /// ### Explanation
2864     ///
2865     /// Deprecation attributes have no effect on trait implementations.
2866     pub USELESS_DEPRECATED,
2867     Deny,
2868     "detects deprecation attributes with no effect",
2869 }
2870
2871 declare_lint! {
2872     /// The `undefined_naked_function_abi` lint detects naked function definitions that
2873     /// either do not specify an ABI or specify the Rust ABI.
2874     ///
2875     /// ### Example
2876     ///
2877     /// ```rust
2878     /// #![feature(asm_experimental_arch, naked_functions)]
2879     ///
2880     /// use std::arch::asm;
2881     ///
2882     /// #[naked]
2883     /// pub fn default_abi() -> u32 {
2884     ///     unsafe { asm!("", options(noreturn)); }
2885     /// }
2886     ///
2887     /// #[naked]
2888     /// pub extern "Rust" fn rust_abi() -> u32 {
2889     ///     unsafe { asm!("", options(noreturn)); }
2890     /// }
2891     /// ```
2892     ///
2893     /// {{produces}}
2894     ///
2895     /// ### Explanation
2896     ///
2897     /// The Rust ABI is currently undefined. Therefore, naked functions should
2898     /// specify a non-Rust ABI.
2899     pub UNDEFINED_NAKED_FUNCTION_ABI,
2900     Warn,
2901     "undefined naked function ABI"
2902 }
2903
2904 declare_lint! {
2905     /// The `ineffective_unstable_trait_impl` lint detects `#[unstable]` attributes which are not used.
2906     ///
2907     /// ### Example
2908     ///
2909     /// ```rust,compile_fail
2910     /// #![feature(staged_api)]
2911     ///
2912     /// #[derive(Clone)]
2913     /// #[stable(feature = "x", since = "1")]
2914     /// struct S {}
2915     ///
2916     /// #[unstable(feature = "y", issue = "none")]
2917     /// impl Copy for S {}
2918     /// ```
2919     ///
2920     /// {{produces}}
2921     ///
2922     /// ### Explanation
2923     ///
2924     /// `staged_api` does not currently support using a stability attribute on `impl` blocks.
2925     /// `impl`s are always stable if both the type and trait are stable, and always unstable otherwise.
2926     pub INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
2927     Deny,
2928     "detects `#[unstable]` on stable trait implementations for stable types"
2929 }
2930
2931 declare_lint! {
2932     /// The `semicolon_in_expressions_from_macros` lint detects trailing semicolons
2933     /// in macro bodies when the macro is invoked in expression position.
2934     /// This was previous accepted, but is being phased out.
2935     ///
2936     /// ### Example
2937     ///
2938     /// ```rust,compile_fail
2939     /// #![deny(semicolon_in_expressions_from_macros)]
2940     /// macro_rules! foo {
2941     ///     () => { true; }
2942     /// }
2943     ///
2944     /// fn main() {
2945     ///     let val = match true {
2946     ///         true => false,
2947     ///         _ => foo!()
2948     ///     };
2949     /// }
2950     /// ```
2951     ///
2952     /// {{produces}}
2953     ///
2954     /// ### Explanation
2955     ///
2956     /// Previous, Rust ignored trailing semicolon in a macro
2957     /// body when a macro was invoked in expression position.
2958     /// However, this makes the treatment of semicolons in the language
2959     /// inconsistent, and could lead to unexpected runtime behavior
2960     /// in some circumstances (e.g. if the macro author expects
2961     /// a value to be dropped).
2962     ///
2963     /// This is a [future-incompatible] lint to transition this
2964     /// to a hard error in the future. See [issue #79813] for more details.
2965     ///
2966     /// [issue #79813]: https://github.com/rust-lang/rust/issues/79813
2967     /// [future-incompatible]: ../index.md#future-incompatible-lints
2968     pub SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
2969     Warn,
2970     "trailing semicolon in macro body used as expression",
2971     @future_incompatible = FutureIncompatibleInfo {
2972         reference: "issue #79813 <https://github.com/rust-lang/rust/issues/79813>",
2973         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
2974     };
2975 }
2976
2977 declare_lint! {
2978     /// The `legacy_derive_helpers` lint detects derive helper attributes
2979     /// that are used before they are introduced.
2980     ///
2981     /// ### Example
2982     ///
2983     /// ```rust,ignore (needs extern crate)
2984     /// #[serde(rename_all = "camelCase")]
2985     /// #[derive(Deserialize)]
2986     /// struct S { /* fields */ }
2987     /// ```
2988     ///
2989     /// produces:
2990     ///
2991     /// ```text
2992     /// warning: derive helper attribute is used before it is introduced
2993     ///   --> $DIR/legacy-derive-helpers.rs:1:3
2994     ///    |
2995     ///  1 | #[serde(rename_all = "camelCase")]
2996     ///    |   ^^^^^
2997     /// ...
2998     ///  2 | #[derive(Deserialize)]
2999     ///    |          ----------- the attribute is introduced here
3000     /// ```
3001     ///
3002     /// ### Explanation
3003     ///
3004     /// Attributes like this work for historical reasons, but attribute expansion works in
3005     /// left-to-right order in general, so, to resolve `#[serde]`, compiler has to try to "look
3006     /// into the future" at not yet expanded part of the item , but such attempts are not always
3007     /// reliable.
3008     ///
3009     /// To fix the warning place the helper attribute after its corresponding derive.
3010     /// ```rust,ignore (needs extern crate)
3011     /// #[derive(Deserialize)]
3012     /// #[serde(rename_all = "camelCase")]
3013     /// struct S { /* fields */ }
3014     /// ```
3015     pub LEGACY_DERIVE_HELPERS,
3016     Warn,
3017     "detects derive helper attributes that are used before they are introduced",
3018     @future_incompatible = FutureIncompatibleInfo {
3019         reference: "issue #79202 <https://github.com/rust-lang/rust/issues/79202>",
3020     };
3021 }
3022
3023 declare_lint! {
3024     /// The `large_assignments` lint detects when objects of large
3025     /// types are being moved around.
3026     ///
3027     /// ### Example
3028     ///
3029     /// ```rust,ignore (can crash on some platforms)
3030     /// let x = [0; 50000];
3031     /// let y = x;
3032     /// ```
3033     ///
3034     /// produces:
3035     ///
3036     /// ```text
3037     /// warning: moving a large value
3038     ///   --> $DIR/move-large.rs:1:3
3039     ///   let y = x;
3040     ///           - Copied large value here
3041     /// ```
3042     ///
3043     /// ### Explanation
3044     ///
3045     /// When using a large type in a plain assignment or in a function
3046     /// argument, idiomatic code can be inefficient.
3047     /// Ideally appropriate optimizations would resolve this, but such
3048     /// optimizations are only done in a best-effort manner.
3049     /// This lint will trigger on all sites of large moves and thus allow the
3050     /// user to resolve them in code.
3051     pub LARGE_ASSIGNMENTS,
3052     Warn,
3053     "detects large moves or copies",
3054 }
3055
3056 declare_lint! {
3057     /// The `deprecated_cfg_attr_crate_type_name` lint detects uses of the
3058     /// `#![cfg_attr(..., crate_type = "...")]` and
3059     /// `#![cfg_attr(..., crate_name = "...")]` attributes to conditionally
3060     /// specify the crate type and name in the source code.
3061     ///
3062     /// ### Example
3063     ///
3064     /// ```rust,compile_fail
3065     /// #![cfg_attr(debug_assertions, crate_type = "lib")]
3066     /// ```
3067     ///
3068     /// {{produces}}
3069     ///
3070     ///
3071     /// ### Explanation
3072     ///
3073     /// The `#![crate_type]` and `#![crate_name]` attributes require a hack in
3074     /// the compiler to be able to change the used crate type and crate name
3075     /// after macros have been expanded. Neither attribute works in combination
3076     /// with Cargo as it explicitly passes `--crate-type` and `--crate-name` on
3077     /// the commandline. These values must match the value used in the source
3078     /// code to prevent an error.
3079     ///
3080     /// To fix the warning use `--crate-type` on the commandline when running
3081     /// rustc instead of `#![cfg_attr(..., crate_type = "...")]` and
3082     /// `--crate-name` instead of `#![cfg_attr(..., crate_name = "...")]`.
3083     pub DEPRECATED_CFG_ATTR_CRATE_TYPE_NAME,
3084     Deny,
3085     "detects usage of `#![cfg_attr(..., crate_type/crate_name = \"...\")]`",
3086     @future_incompatible = FutureIncompatibleInfo {
3087         reference: "issue #91632 <https://github.com/rust-lang/rust/issues/91632>",
3088     };
3089 }
3090
3091 declare_lint! {
3092     /// The `unexpected_cfgs` lint detects unexpected conditional compilation conditions.
3093     ///
3094     /// ### Example
3095     ///
3096     /// ```text
3097     /// rustc --check-cfg 'names()'
3098     /// ```
3099     ///
3100     /// ```rust,ignore (needs command line option)
3101     /// #[cfg(widnows)]
3102     /// fn foo() {}
3103     /// ```
3104     ///
3105     /// This will produce:
3106     ///
3107     /// ```text
3108     /// warning: unknown condition name used
3109     ///  --> lint_example.rs:1:7
3110     ///   |
3111     /// 1 | #[cfg(widnows)]
3112     ///   |       ^^^^^^^
3113     ///   |
3114     ///   = note: `#[warn(unexpected_cfgs)]` on by default
3115     /// ```
3116     ///
3117     /// ### Explanation
3118     ///
3119     /// This lint is only active when a `--check-cfg='names(...)'` option has been passed
3120     /// to the compiler and triggers whenever an unknown condition name or value is used.
3121     /// The known condition include names or values passed in `--check-cfg`, `--cfg`, and some
3122     /// well-knows names and values built into the compiler.
3123     pub UNEXPECTED_CFGS,
3124     Warn,
3125     "detects unexpected names and values in `#[cfg]` conditions",
3126 }
3127
3128 declare_lint! {
3129     /// The `repr_transparent_external_private_fields` lint
3130     /// detects types marked `#[repr(transparent)]` that (transitively)
3131     /// contain an external ZST type marked `#[non_exhaustive]` or containing
3132     /// private fields
3133     ///
3134     /// ### Example
3135     ///
3136     /// ```rust,ignore (needs external crate)
3137     /// #![deny(repr_transparent_external_private_fields)]
3138     /// use foo::NonExhaustiveZst;
3139     ///
3140     /// #[repr(transparent)]
3141     /// struct Bar(u32, ([u32; 0], NonExhaustiveZst));
3142     /// ```
3143     ///
3144     /// This will produce:
3145     ///
3146     /// ```text
3147     /// error: zero-sized fields in repr(transparent) cannot contain external non-exhaustive types
3148     ///  --> src/main.rs:5:28
3149     ///   |
3150     /// 5 | struct Bar(u32, ([u32; 0], NonExhaustiveZst));
3151     ///   |                            ^^^^^^^^^^^^^^^^
3152     ///   |
3153     /// note: the lint level is defined here
3154     ///  --> src/main.rs:1:9
3155     ///   |
3156     /// 1 | #![deny(repr_transparent_external_private_fields)]
3157     ///   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3158     ///   = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3159     ///   = note: for more information, see issue #78586 <https://github.com/rust-lang/rust/issues/78586>
3160     ///   = note: this struct contains `NonExhaustiveZst`, which is marked with `#[non_exhaustive]`, and makes it not a breaking change to become non-zero-sized in the future.
3161     /// ```
3162     ///
3163     /// ### Explanation
3164     ///
3165     /// Previous, Rust accepted fields that contain external private zero-sized types,
3166     /// even though it should not be a breaking change to add a non-zero-sized field to
3167     /// that private type.
3168     ///
3169     /// This is a [future-incompatible] lint to transition this
3170     /// to a hard error in the future. See [issue #78586] for more details.
3171     ///
3172     /// [issue #78586]: https://github.com/rust-lang/rust/issues/78586
3173     /// [future-incompatible]: ../index.md#future-incompatible-lints
3174     pub REPR_TRANSPARENT_EXTERNAL_PRIVATE_FIELDS,
3175     Warn,
3176     "transparent type contains an external ZST that is marked #[non_exhaustive] or contains private fields",
3177     @future_incompatible = FutureIncompatibleInfo {
3178         reference: "issue #78586 <https://github.com/rust-lang/rust/issues/78586>",
3179     };
3180 }
3181
3182 declare_lint! {
3183     /// The `unstable_syntax_pre_expansion` lint detects the use of unstable
3184     /// syntax that is discarded during attribute expansion.
3185     ///
3186     /// ### Example
3187     ///
3188     /// ```rust
3189     /// #[cfg(FALSE)]
3190     /// macro foo() {}
3191     /// ```
3192     ///
3193     /// {{produces}}
3194     ///
3195     /// ### Explanation
3196     ///
3197     /// The input to active attributes such as `#[cfg]` or procedural macro
3198     /// attributes is required to be valid syntax. Previously, the compiler only
3199     /// gated the use of unstable syntax features after resolving `#[cfg]` gates
3200     /// and expanding procedural macros.
3201     ///
3202     /// To avoid relying on unstable syntax, move the use of unstable syntax
3203     /// into a position where the compiler does not parse the syntax, such as a
3204     /// functionlike macro.
3205     ///
3206     /// ```rust
3207     /// # #![deny(unstable_syntax_pre_expansion)]
3208     ///
3209     /// macro_rules! identity {
3210     ///    ( $($tokens:tt)* ) => { $($tokens)* }
3211     /// }
3212     ///
3213     /// #[cfg(FALSE)]
3214     /// identity! {
3215     ///    macro foo() {}
3216     /// }
3217     /// ```
3218     ///
3219     /// This is a [future-incompatible] lint to transition this
3220     /// to a hard error in the future. See [issue #65860] for more details.
3221     ///
3222     /// [issue #65860]: https://github.com/rust-lang/rust/issues/65860
3223     /// [future-incompatible]: ../index.md#future-incompatible-lints
3224     pub UNSTABLE_SYNTAX_PRE_EXPANSION,
3225     Warn,
3226     "unstable syntax can change at any point in the future, causing a hard error!",
3227     @future_incompatible = FutureIncompatibleInfo {
3228         reference: "issue #65860 <https://github.com/rust-lang/rust/issues/65860>",
3229     };
3230 }
3231
3232 declare_lint_pass! {
3233     /// Does nothing as a lint pass, but registers some `Lint`s
3234     /// that are used by other parts of the compiler.
3235     HardwiredLints => [
3236         FORBIDDEN_LINT_GROUPS,
3237         ILLEGAL_FLOATING_POINT_LITERAL_PATTERN,
3238         ARITHMETIC_OVERFLOW,
3239         UNCONDITIONAL_PANIC,
3240         UNUSED_IMPORTS,
3241         UNUSED_EXTERN_CRATES,
3242         UNUSED_CRATE_DEPENDENCIES,
3243         UNUSED_QUALIFICATIONS,
3244         UNKNOWN_LINTS,
3245         UNFULFILLED_LINT_EXPECTATIONS,
3246         UNUSED_VARIABLES,
3247         UNUSED_ASSIGNMENTS,
3248         DEAD_CODE,
3249         UNREACHABLE_CODE,
3250         UNREACHABLE_PATTERNS,
3251         OVERLAPPING_RANGE_ENDPOINTS,
3252         BINDINGS_WITH_VARIANT_NAME,
3253         UNUSED_MACROS,
3254         UNUSED_MACRO_RULES,
3255         WARNINGS,
3256         UNUSED_FEATURES,
3257         STABLE_FEATURES,
3258         UNKNOWN_CRATE_TYPES,
3259         TRIVIAL_CASTS,
3260         TRIVIAL_NUMERIC_CASTS,
3261         PRIVATE_IN_PUBLIC,
3262         EXPORTED_PRIVATE_DEPENDENCIES,
3263         PUB_USE_OF_PRIVATE_EXTERN_CRATE,
3264         INVALID_TYPE_PARAM_DEFAULT,
3265         RENAMED_AND_REMOVED_LINTS,
3266         CONST_ITEM_MUTATION,
3267         PATTERNS_IN_FNS_WITHOUT_BODY,
3268         MISSING_FRAGMENT_SPECIFIER,
3269         LATE_BOUND_LIFETIME_ARGUMENTS,
3270         ORDER_DEPENDENT_TRAIT_OBJECTS,
3271         COHERENCE_LEAK_CHECK,
3272         DEPRECATED,
3273         UNUSED_UNSAFE,
3274         UNUSED_MUT,
3275         UNCONDITIONAL_RECURSION,
3276         SINGLE_USE_LIFETIMES,
3277         UNUSED_LIFETIMES,
3278         UNUSED_LABELS,
3279         TYVAR_BEHIND_RAW_POINTER,
3280         ELIDED_LIFETIMES_IN_PATHS,
3281         BARE_TRAIT_OBJECTS,
3282         ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
3283         UNSTABLE_NAME_COLLISIONS,
3284         IRREFUTABLE_LET_PATTERNS,
3285         WHERE_CLAUSES_OBJECT_SAFETY,
3286         PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
3287         MACRO_USE_EXTERN_CRATE,
3288         MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
3289         ILL_FORMED_ATTRIBUTE_INPUT,
3290         CONFLICTING_REPR_HINTS,
3291         META_VARIABLE_MISUSE,
3292         DEPRECATED_IN_FUTURE,
3293         AMBIGUOUS_ASSOCIATED_ITEMS,
3294         INDIRECT_STRUCTURAL_MATCH,
3295         POINTER_STRUCTURAL_MATCH,
3296         NONTRIVIAL_STRUCTURAL_MATCH,
3297         SOFT_UNSTABLE,
3298         UNSTABLE_SYNTAX_PRE_EXPANSION,
3299         INLINE_NO_SANITIZE,
3300         BAD_ASM_STYLE,
3301         ASM_SUB_REGISTER,
3302         UNSAFE_OP_IN_UNSAFE_FN,
3303         INCOMPLETE_INCLUDE,
3304         CENUM_IMPL_DROP_CAST,
3305         FUZZY_PROVENANCE_CASTS,
3306         LOSSY_PROVENANCE_CASTS,
3307         CONST_EVALUATABLE_UNCHECKED,
3308         INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
3309         MUST_NOT_SUSPEND,
3310         UNINHABITED_STATIC,
3311         FUNCTION_ITEM_REFERENCES,
3312         USELESS_DEPRECATED,
3313         MISSING_ABI,
3314         INVALID_DOC_ATTRIBUTES,
3315         SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
3316         RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
3317         LEGACY_DERIVE_HELPERS,
3318         PROC_MACRO_BACK_COMPAT,
3319         RUST_2021_INCOMPATIBLE_OR_PATTERNS,
3320         LARGE_ASSIGNMENTS,
3321         RUST_2021_PRELUDE_COLLISIONS,
3322         RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
3323         UNSUPPORTED_CALLING_CONVENTIONS,
3324         BREAK_WITH_LABEL_AND_LOOP,
3325         UNUSED_ATTRIBUTES,
3326         UNUSED_TUPLE_STRUCT_FIELDS,
3327         NON_EXHAUSTIVE_OMITTED_PATTERNS,
3328         TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
3329         DEPRECATED_CFG_ATTR_CRATE_TYPE_NAME,
3330         DUPLICATE_MACRO_ATTRIBUTES,
3331         SUSPICIOUS_AUTO_TRAIT_IMPLS,
3332         DEPRECATED_WHERE_CLAUSE_LOCATION,
3333         TEST_UNSTABLE_LINT,
3334         FFI_UNWIND_CALLS,
3335         REPR_TRANSPARENT_EXTERNAL_PRIVATE_FIELDS,
3336         NAMED_ARGUMENTS_USED_POSITIONALLY,
3337         IMPLIED_BOUNDS_ENTAILMENT,
3338         BYTE_SLICE_IN_PACKED_STRUCT_WITH_DERIVE,
3339     ]
3340 }
3341
3342 declare_lint! {
3343     /// The `unused_doc_comments` lint detects doc comments that aren't used
3344     /// by `rustdoc`.
3345     ///
3346     /// ### Example
3347     ///
3348     /// ```rust
3349     /// /// docs for x
3350     /// let x = 12;
3351     /// ```
3352     ///
3353     /// {{produces}}
3354     ///
3355     /// ### Explanation
3356     ///
3357     /// `rustdoc` does not use doc comments in all positions, and so the doc
3358     /// comment will be ignored. Try changing it to a normal comment with `//`
3359     /// to avoid the warning.
3360     pub UNUSED_DOC_COMMENTS,
3361     Warn,
3362     "detects doc comments that aren't used by rustdoc"
3363 }
3364
3365 declare_lint! {
3366     /// The `rust_2021_incompatible_closure_captures` lint detects variables that aren't completely
3367     /// captured in Rust 2021, such that the `Drop` order of their fields may differ between
3368     /// Rust 2018 and 2021.
3369     ///
3370     /// It can also detect when a variable implements a trait like `Send`, but one of its fields does not,
3371     /// and the field is captured by a closure and used with the assumption that said field implements
3372     /// the same trait as the root variable.
3373     ///
3374     /// ### Example of drop reorder
3375     ///
3376     /// ```rust,edition2018,compile_fail
3377     /// #![deny(rust_2021_incompatible_closure_captures)]
3378     /// # #![allow(unused)]
3379     ///
3380     /// struct FancyInteger(i32);
3381     ///
3382     /// impl Drop for FancyInteger {
3383     ///     fn drop(&mut self) {
3384     ///         println!("Just dropped {}", self.0);
3385     ///     }
3386     /// }
3387     ///
3388     /// struct Point { x: FancyInteger, y: FancyInteger }
3389     ///
3390     /// fn main() {
3391     ///   let p = Point { x: FancyInteger(10), y: FancyInteger(20) };
3392     ///
3393     ///   let c = || {
3394     ///      let x = p.x;
3395     ///   };
3396     ///
3397     ///   c();
3398     ///
3399     ///   // ... More code ...
3400     /// }
3401     /// ```
3402     ///
3403     /// {{produces}}
3404     ///
3405     /// ### Explanation
3406     ///
3407     /// In the above example, `p.y` will be dropped at the end of `f` instead of
3408     /// with `c` in Rust 2021.
3409     ///
3410     /// ### Example of auto-trait
3411     ///
3412     /// ```rust,edition2018,compile_fail
3413     /// #![deny(rust_2021_incompatible_closure_captures)]
3414     /// use std::thread;
3415     ///
3416     /// struct Pointer(*mut i32);
3417     /// unsafe impl Send for Pointer {}
3418     ///
3419     /// fn main() {
3420     ///     let mut f = 10;
3421     ///     let fptr = Pointer(&mut f as *mut i32);
3422     ///     thread::spawn(move || unsafe {
3423     ///         *fptr.0 = 20;
3424     ///     });
3425     /// }
3426     /// ```
3427     ///
3428     /// {{produces}}
3429     ///
3430     /// ### Explanation
3431     ///
3432     /// In the above example, only `fptr.0` is captured in Rust 2021.
3433     /// The field is of type `*mut i32`, which doesn't implement `Send`,
3434     /// making the code invalid as the field cannot be sent between threads safely.
3435     pub RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
3436     Allow,
3437     "detects closures affected by Rust 2021 changes",
3438     @future_incompatible = FutureIncompatibleInfo {
3439         reason: FutureIncompatibilityReason::EditionSemanticsChange(Edition::Edition2021),
3440         explain_reason: false,
3441     };
3442 }
3443
3444 declare_lint_pass!(UnusedDocComment => [UNUSED_DOC_COMMENTS]);
3445
3446 declare_lint! {
3447     /// The `missing_abi` lint detects cases where the ABI is omitted from
3448     /// extern declarations.
3449     ///
3450     /// ### Example
3451     ///
3452     /// ```rust,compile_fail
3453     /// #![deny(missing_abi)]
3454     ///
3455     /// extern fn foo() {}
3456     /// ```
3457     ///
3458     /// {{produces}}
3459     ///
3460     /// ### Explanation
3461     ///
3462     /// Historically, Rust implicitly selected C as the ABI for extern
3463     /// declarations. We expect to add new ABIs, like `C-unwind`, in the future,
3464     /// though this has not yet happened, and especially with their addition
3465     /// seeing the ABI easily will make code review easier.
3466     pub MISSING_ABI,
3467     Allow,
3468     "No declared ABI for extern declaration"
3469 }
3470
3471 declare_lint! {
3472     /// The `invalid_doc_attributes` lint detects when the `#[doc(...)]` is
3473     /// misused.
3474     ///
3475     /// ### Example
3476     ///
3477     /// ```rust,compile_fail
3478     /// #![deny(warnings)]
3479     ///
3480     /// pub mod submodule {
3481     ///     #![doc(test(no_crate_inject))]
3482     /// }
3483     /// ```
3484     ///
3485     /// {{produces}}
3486     ///
3487     /// ### Explanation
3488     ///
3489     /// Previously, incorrect usage of the `#[doc(..)]` attribute was not
3490     /// being validated. Usually these should be rejected as a hard error,
3491     /// but this lint was introduced to avoid breaking any existing
3492     /// crates which included them.
3493     ///
3494     /// This is a [future-incompatible] lint to transition this to a hard
3495     /// error in the future. See [issue #82730] for more details.
3496     ///
3497     /// [issue #82730]: https://github.com/rust-lang/rust/issues/82730
3498     pub INVALID_DOC_ATTRIBUTES,
3499     Warn,
3500     "detects invalid `#[doc(...)]` attributes",
3501     @future_incompatible = FutureIncompatibleInfo {
3502         reference: "issue #82730 <https://github.com/rust-lang/rust/issues/82730>",
3503     };
3504 }
3505
3506 declare_lint! {
3507     /// The `proc_macro_back_compat` lint detects uses of old versions of certain
3508     /// proc-macro crates, which have hardcoded workarounds in the compiler.
3509     ///
3510     /// ### Example
3511     ///
3512     /// ```rust,ignore (needs-dependency)
3513     ///
3514     /// use time_macros_impl::impl_macros;
3515     /// struct Foo;
3516     /// impl_macros!(Foo);
3517     /// ```
3518     ///
3519     /// This will produce:
3520     ///
3521     /// ```text
3522     /// warning: using an old version of `time-macros-impl`
3523     ///   ::: $DIR/group-compat-hack.rs:27:5
3524     ///    |
3525     /// LL |     impl_macros!(Foo);
3526     ///    |     ------------------ in this macro invocation
3527     ///    |
3528     ///    = note: `#[warn(proc_macro_back_compat)]` on by default
3529     ///    = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3530     ///    = note: for more information, see issue #83125 <https://github.com/rust-lang/rust/issues/83125>
3531     ///    = 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
3532     ///    = note: this warning originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
3533     /// ```
3534     ///
3535     /// ### Explanation
3536     ///
3537     /// Eventually, the backwards-compatibility hacks present in the compiler will be removed,
3538     /// causing older versions of certain crates to stop compiling.
3539     /// This is a [future-incompatible] lint to ease the transition to an error.
3540     /// See [issue #83125] for more details.
3541     ///
3542     /// [issue #83125]: https://github.com/rust-lang/rust/issues/83125
3543     /// [future-incompatible]: ../index.md#future-incompatible-lints
3544     pub PROC_MACRO_BACK_COMPAT,
3545     Deny,
3546     "detects usage of old versions of certain proc-macro crates",
3547     @future_incompatible = FutureIncompatibleInfo {
3548         reference: "issue #83125 <https://github.com/rust-lang/rust/issues/83125>",
3549         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
3550     };
3551 }
3552
3553 declare_lint! {
3554     /// The `rust_2021_incompatible_or_patterns` lint detects usage of old versions of or-patterns.
3555     ///
3556     /// ### Example
3557     ///
3558     /// ```rust,compile_fail
3559     /// #![deny(rust_2021_incompatible_or_patterns)]
3560     ///
3561     /// macro_rules! match_any {
3562     ///     ( $expr:expr , $( $( $pat:pat )|+ => $expr_arm:expr ),+ ) => {
3563     ///         match $expr {
3564     ///             $(
3565     ///                 $( $pat => $expr_arm, )+
3566     ///             )+
3567     ///         }
3568     ///     };
3569     /// }
3570     ///
3571     /// fn main() {
3572     ///     let result: Result<i64, i32> = Err(42);
3573     ///     let int: i64 = match_any!(result, Ok(i) | Err(i) => i.into());
3574     ///     assert_eq!(int, 42);
3575     /// }
3576     /// ```
3577     ///
3578     /// {{produces}}
3579     ///
3580     /// ### Explanation
3581     ///
3582     /// In Rust 2021, the `pat` matcher will match additional patterns, which include the `|` character.
3583     pub RUST_2021_INCOMPATIBLE_OR_PATTERNS,
3584     Allow,
3585     "detects usage of old versions of or-patterns",
3586     @future_incompatible = FutureIncompatibleInfo {
3587         reference: "<https://doc.rust-lang.org/nightly/edition-guide/rust-2021/or-patterns-macro-rules.html>",
3588         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2021),
3589     };
3590 }
3591
3592 declare_lint! {
3593     /// The `rust_2021_prelude_collisions` lint detects the usage of trait methods which are ambiguous
3594     /// with traits added to the prelude in future editions.
3595     ///
3596     /// ### Example
3597     ///
3598     /// ```rust,compile_fail
3599     /// #![deny(rust_2021_prelude_collisions)]
3600     ///
3601     /// trait Foo {
3602     ///     fn try_into(self) -> Result<String, !>;
3603     /// }
3604     ///
3605     /// impl Foo for &str {
3606     ///     fn try_into(self) -> Result<String, !> {
3607     ///         Ok(String::from(self))
3608     ///     }
3609     /// }
3610     ///
3611     /// fn main() {
3612     ///     let x: String = "3".try_into().unwrap();
3613     ///     //                  ^^^^^^^^
3614     ///     // This call to try_into matches both Foo::try_into and TryInto::try_into as
3615     ///     // `TryInto` has been added to the Rust prelude in 2021 edition.
3616     ///     println!("{x}");
3617     /// }
3618     /// ```
3619     ///
3620     /// {{produces}}
3621     ///
3622     /// ### Explanation
3623     ///
3624     /// In Rust 2021, one of the important introductions is the [prelude changes], which add
3625     /// `TryFrom`, `TryInto`, and `FromIterator` into the standard library's prelude. Since this
3626     /// results in an ambiguity as to which method/function to call when an existing `try_into`
3627     /// method is called via dot-call syntax or a `try_from`/`from_iter` associated function
3628     /// is called directly on a type.
3629     ///
3630     /// [prelude changes]: https://blog.rust-lang.org/inside-rust/2021/03/04/planning-rust-2021.html#prelude-changes
3631     pub RUST_2021_PRELUDE_COLLISIONS,
3632     Allow,
3633     "detects the usage of trait methods which are ambiguous with traits added to the \
3634         prelude in future editions",
3635     @future_incompatible = FutureIncompatibleInfo {
3636         reference: "<https://doc.rust-lang.org/nightly/edition-guide/rust-2021/prelude.html>",
3637         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2021),
3638     };
3639 }
3640
3641 declare_lint! {
3642     /// The `rust_2021_prefixes_incompatible_syntax` lint detects identifiers that will be parsed as a
3643     /// prefix instead in Rust 2021.
3644     ///
3645     /// ### Example
3646     ///
3647     /// ```rust,edition2018,compile_fail
3648     /// #![deny(rust_2021_prefixes_incompatible_syntax)]
3649     ///
3650     /// macro_rules! m {
3651     ///     (z $x:expr) => ();
3652     /// }
3653     ///
3654     /// m!(z"hey");
3655     /// ```
3656     ///
3657     /// {{produces}}
3658     ///
3659     /// ### Explanation
3660     ///
3661     /// In Rust 2015 and 2018, `z"hey"` is two tokens: the identifier `z`
3662     /// followed by the string literal `"hey"`. In Rust 2021, the `z` is
3663     /// considered a prefix for `"hey"`.
3664     ///
3665     /// This lint suggests to add whitespace between the `z` and `"hey"` tokens
3666     /// to keep them separated in Rust 2021.
3667     // Allow this lint -- rustdoc doesn't yet support threading edition into this lint's parser.
3668     #[allow(rustdoc::invalid_rust_codeblocks)]
3669     pub RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
3670     Allow,
3671     "identifiers that will be parsed as a prefix in Rust 2021",
3672     @future_incompatible = FutureIncompatibleInfo {
3673         reference: "<https://doc.rust-lang.org/nightly/edition-guide/rust-2021/reserving-syntax.html>",
3674         reason: FutureIncompatibilityReason::EditionError(Edition::Edition2021),
3675     };
3676     crate_level_only
3677 }
3678
3679 declare_lint! {
3680     /// The `unsupported_calling_conventions` lint is output whenever there is a use of the
3681     /// `stdcall`, `fastcall`, `thiscall`, `vectorcall` calling conventions (or their unwind
3682     /// variants) on targets that cannot meaningfully be supported for the requested target.
3683     ///
3684     /// For example `stdcall` does not make much sense for a x86_64 or, more apparently, powerpc
3685     /// code, because this calling convention was never specified for those targets.
3686     ///
3687     /// Historically MSVC toolchains have fallen back to the regular C calling convention for
3688     /// targets other than x86, but Rust doesn't really see a similar need to introduce a similar
3689     /// hack across many more targets.
3690     ///
3691     /// ### Example
3692     ///
3693     /// ```rust,ignore (needs specific targets)
3694     /// extern "stdcall" fn stdcall() {}
3695     /// ```
3696     ///
3697     /// This will produce:
3698     ///
3699     /// ```text
3700     /// warning: use of calling convention not supported on this target
3701     ///   --> $DIR/unsupported.rs:39:1
3702     ///    |
3703     /// LL | extern "stdcall" fn stdcall() {}
3704     ///    | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3705     ///    |
3706     ///    = note: `#[warn(unsupported_calling_conventions)]` on by default
3707     ///    = warning: this was previously accepted by the compiler but is being phased out;
3708     ///               it will become a hard error in a future release!
3709     ///    = note: for more information, see issue ...
3710     /// ```
3711     ///
3712     /// ### Explanation
3713     ///
3714     /// On most of the targets the behaviour of `stdcall` and similar calling conventions is not
3715     /// defined at all, but was previously accepted due to a bug in the implementation of the
3716     /// compiler.
3717     pub UNSUPPORTED_CALLING_CONVENTIONS,
3718     Warn,
3719     "use of unsupported calling convention",
3720     @future_incompatible = FutureIncompatibleInfo {
3721         reference: "issue #87678 <https://github.com/rust-lang/rust/issues/87678>",
3722     };
3723 }
3724
3725 declare_lint! {
3726     /// The `break_with_label_and_loop` lint detects labeled `break` expressions with
3727     /// an unlabeled loop as their value expression.
3728     ///
3729     /// ### Example
3730     ///
3731     /// ```rust
3732     /// 'label: loop {
3733     ///     break 'label loop { break 42; };
3734     /// };
3735     /// ```
3736     ///
3737     /// {{produces}}
3738     ///
3739     /// ### Explanation
3740     ///
3741     /// In Rust, loops can have a label, and `break` expressions can refer to that label to
3742     /// break out of specific loops (and not necessarily the innermost one). `break` expressions
3743     /// can also carry a value expression, which can be another loop. A labeled `break` with an
3744     /// unlabeled loop as its value expression is easy to confuse with an unlabeled break with
3745     /// a labeled loop and is thus discouraged (but allowed for compatibility); use parentheses
3746     /// around the loop expression to silence this warning. Unlabeled `break` expressions with
3747     /// labeled loops yield a hard error, which can also be silenced by wrapping the expression
3748     /// in parentheses.
3749     pub BREAK_WITH_LABEL_AND_LOOP,
3750     Warn,
3751     "`break` expression with label and unlabeled loop as value expression"
3752 }
3753
3754 declare_lint! {
3755     /// The `non_exhaustive_omitted_patterns` lint detects when a wildcard (`_` or `..`) in a
3756     /// pattern for a `#[non_exhaustive]` struct or enum is reachable.
3757     ///
3758     /// ### Example
3759     ///
3760     /// ```rust,ignore (needs separate crate)
3761     /// // crate A
3762     /// #[non_exhaustive]
3763     /// pub enum Bar {
3764     ///     A,
3765     ///     B, // added variant in non breaking change
3766     /// }
3767     ///
3768     /// // in crate B
3769     /// #![feature(non_exhaustive_omitted_patterns_lint)]
3770     ///
3771     /// match Bar::A {
3772     ///     Bar::A => {},
3773     ///     #[warn(non_exhaustive_omitted_patterns)]
3774     ///     _ => {},
3775     /// }
3776     /// ```
3777     ///
3778     /// This will produce:
3779     ///
3780     /// ```text
3781     /// warning: reachable patterns not covered of non exhaustive enum
3782     ///    --> $DIR/reachable-patterns.rs:70:9
3783     ///    |
3784     /// LL |         _ => {}
3785     ///    |         ^ pattern `B` not covered
3786     ///    |
3787     ///  note: the lint level is defined here
3788     ///   --> $DIR/reachable-patterns.rs:69:16
3789     ///    |
3790     /// LL |         #[warn(non_exhaustive_omitted_patterns)]
3791     ///    |                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3792     ///    = help: ensure that all possible cases are being handled by adding the suggested match arms
3793     ///    = note: the matched value is of type `Bar` and the `non_exhaustive_omitted_patterns` attribute was found
3794     /// ```
3795     ///
3796     /// ### Explanation
3797     ///
3798     /// Structs and enums tagged with `#[non_exhaustive]` force the user to add a
3799     /// (potentially redundant) wildcard when pattern-matching, to allow for future
3800     /// addition of fields or variants. The `non_exhaustive_omitted_patterns` lint
3801     /// detects when such a wildcard happens to actually catch some fields/variants.
3802     /// In other words, when the match without the wildcard would not be exhaustive.
3803     /// This lets the user be informed if new fields/variants were added.
3804     pub NON_EXHAUSTIVE_OMITTED_PATTERNS,
3805     Allow,
3806     "detect when patterns of types marked `non_exhaustive` are missed",
3807     @feature_gate = sym::non_exhaustive_omitted_patterns_lint;
3808 }
3809
3810 declare_lint! {
3811     /// The `text_direction_codepoint_in_comment` lint detects Unicode codepoints in comments that
3812     /// change the visual representation of text on screen in a way that does not correspond to
3813     /// their on memory representation.
3814     ///
3815     /// ### Example
3816     ///
3817     /// ```rust,compile_fail
3818     /// #![deny(text_direction_codepoint_in_comment)]
3819     /// fn main() {
3820     ///     println!("{:?}"); // '‮');
3821     /// }
3822     /// ```
3823     ///
3824     /// {{produces}}
3825     ///
3826     /// ### Explanation
3827     ///
3828     /// Unicode allows changing the visual flow of text on screen in order to support scripts that
3829     /// are written right-to-left, but a specially crafted comment can make code that will be
3830     /// compiled appear to be part of a comment, depending on the software used to read the code.
3831     /// To avoid potential problems or confusion, such as in CVE-2021-42574, by default we deny
3832     /// their use.
3833     pub TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
3834     Deny,
3835     "invisible directionality-changing codepoints in comment"
3836 }
3837
3838 declare_lint! {
3839     /// The `duplicate_macro_attributes` lint detects when a `#[test]`-like built-in macro
3840     /// attribute is duplicated on an item. This lint may trigger on `bench`, `cfg_eval`, `test`
3841     /// and `test_case`.
3842     ///
3843     /// ### Example
3844     ///
3845     /// ```rust,ignore (needs --test)
3846     /// #[test]
3847     /// #[test]
3848     /// fn foo() {}
3849     /// ```
3850     ///
3851     /// This will produce:
3852     ///
3853     /// ```text
3854     /// warning: duplicated attribute
3855     ///  --> src/lib.rs:2:1
3856     ///   |
3857     /// 2 | #[test]
3858     ///   | ^^^^^^^
3859     ///   |
3860     ///   = note: `#[warn(duplicate_macro_attributes)]` on by default
3861     /// ```
3862     ///
3863     /// ### Explanation
3864     ///
3865     /// A duplicated attribute may erroneously originate from a copy-paste and the effect of it
3866     /// being duplicated may not be obvious or desirable.
3867     ///
3868     /// For instance, doubling the `#[test]` attributes registers the test to be run twice with no
3869     /// change to its environment.
3870     ///
3871     /// [issue #90979]: https://github.com/rust-lang/rust/issues/90979
3872     pub DUPLICATE_MACRO_ATTRIBUTES,
3873     Warn,
3874     "duplicated attribute"
3875 }
3876
3877 declare_lint! {
3878     /// The `suspicious_auto_trait_impls` lint checks for potentially incorrect
3879     /// implementations of auto traits.
3880     ///
3881     /// ### Example
3882     ///
3883     /// ```rust
3884     /// struct Foo<T>(T);
3885     ///
3886     /// unsafe impl<T> Send for Foo<*const T> {}
3887     /// ```
3888     ///
3889     /// {{produces}}
3890     ///
3891     /// ### Explanation
3892     ///
3893     /// A type can implement auto traits, e.g. `Send`, `Sync` and `Unpin`,
3894     /// in two different ways: either by writing an explicit impl or if
3895     /// all fields of the type implement that auto trait.
3896     ///
3897     /// The compiler disables the automatic implementation if an explicit one
3898     /// exists for given type constructor. The exact rules governing this
3899     /// are currently unsound, quite subtle, and will be modified in the future.
3900     /// This change will cause the automatic implementation to be disabled in more
3901     /// cases, potentially breaking some code.
3902     pub SUSPICIOUS_AUTO_TRAIT_IMPLS,
3903     Warn,
3904     "the rules governing auto traits will change in the future",
3905     @future_incompatible = FutureIncompatibleInfo {
3906         reason: FutureIncompatibilityReason::FutureReleaseSemanticsChange,
3907         reference: "issue #93367 <https://github.com/rust-lang/rust/issues/93367>",
3908     };
3909 }
3910
3911 declare_lint! {
3912     /// The `deprecated_where_clause_location` lint detects when a where clause in front of the equals
3913     /// in an associated type.
3914     ///
3915     /// ### Example
3916     ///
3917     /// ```rust
3918     /// trait Trait {
3919     ///   type Assoc<'a> where Self: 'a;
3920     /// }
3921     ///
3922     /// impl Trait for () {
3923     ///   type Assoc<'a> where Self: 'a = ();
3924     /// }
3925     /// ```
3926     ///
3927     /// {{produces}}
3928     ///
3929     /// ### Explanation
3930     ///
3931     /// The preferred location for where clauses on associated types in impls
3932     /// is after the type. However, for most of generic associated types development,
3933     /// it was only accepted before the equals. To provide a transition period and
3934     /// further evaluate this change, both are currently accepted. At some point in
3935     /// the future, this may be disallowed at an edition boundary; but, that is
3936     /// undecided currently.
3937     pub DEPRECATED_WHERE_CLAUSE_LOCATION,
3938     Warn,
3939     "deprecated where clause location"
3940 }
3941
3942 declare_lint! {
3943     /// The `test_unstable_lint` lint tests unstable lints and is perma-unstable.
3944     ///
3945     /// ### Example
3946     ///
3947     /// ```rust
3948     /// #![allow(test_unstable_lint)]
3949     /// ```
3950     ///
3951     /// {{produces}}
3952     ///
3953     /// ### Explanation
3954     ///
3955     /// In order to test the behavior of unstable lints, a permanently-unstable
3956     /// lint is required. This lint can be used to trigger warnings and errors
3957     /// from the compiler related to unstable lints.
3958     pub TEST_UNSTABLE_LINT,
3959     Deny,
3960     "this unstable lint is only for testing",
3961     @feature_gate = sym::test_unstable_lint;
3962 }
3963
3964 declare_lint! {
3965     /// The `ffi_unwind_calls` lint detects calls to foreign functions or function pointers with
3966     /// `C-unwind` or other FFI-unwind ABIs.
3967     ///
3968     /// ### Example
3969     ///
3970     /// ```rust,ignore (need FFI)
3971     /// #![feature(ffi_unwind_calls)]
3972     /// #![feature(c_unwind)]
3973     ///
3974     /// # mod impl {
3975     /// #     #[no_mangle]
3976     /// #     pub fn "C-unwind" fn foo() {}
3977     /// # }
3978     ///
3979     /// extern "C-unwind" {
3980     ///     fn foo();
3981     /// }
3982     ///
3983     /// fn bar() {
3984     ///     unsafe { foo(); }
3985     ///     let ptr: unsafe extern "C-unwind" fn() = foo;
3986     ///     unsafe { ptr(); }
3987     /// }
3988     /// ```
3989     ///
3990     /// {{produces}}
3991     ///
3992     /// ### Explanation
3993     ///
3994     /// For crates containing such calls, if they are compiled with `-C panic=unwind` then the
3995     /// produced library cannot be linked with crates compiled with `-C panic=abort`. For crates
3996     /// that desire this ability it is therefore necessary to avoid such calls.
3997     pub FFI_UNWIND_CALLS,
3998     Allow,
3999     "call to foreign functions or function pointers with FFI-unwind ABI",
4000     @feature_gate = sym::c_unwind;
4001 }
4002
4003 declare_lint! {
4004     /// The `named_arguments_used_positionally` lint detects cases where named arguments are only
4005     /// used positionally in format strings. This usage is valid but potentially very confusing.
4006     ///
4007     /// ### Example
4008     ///
4009     /// ```rust,compile_fail
4010     /// #![deny(named_arguments_used_positionally)]
4011     /// fn main() {
4012     ///     let _x = 5;
4013     ///     println!("{}", _x = 1); // Prints 1, will trigger lint
4014     ///
4015     ///     println!("{}", _x); // Prints 5, no lint emitted
4016     ///     println!("{_x}", _x = _x); // Prints 5, no lint emitted
4017     /// }
4018     /// ```
4019     ///
4020     /// {{produces}}
4021     ///
4022     /// ### Explanation
4023     ///
4024     /// Rust formatting strings can refer to named arguments by their position, but this usage is
4025     /// potentially confusing. In particular, readers can incorrectly assume that the declaration
4026     /// of named arguments is an assignment (which would produce the unit type).
4027     /// For backwards compatibility, this is not a hard error.
4028     pub NAMED_ARGUMENTS_USED_POSITIONALLY,
4029     Warn,
4030     "named arguments in format used positionally"
4031 }
4032
4033 declare_lint! {
4034     /// The `implied_bounds_entailment` lint detects cases where the arguments of an impl method
4035     /// have stronger implied bounds than those from the trait method it's implementing.
4036     ///
4037     /// ### Example
4038     ///
4039     /// ```rust,compile_fail
4040     /// #![deny(implied_bounds_entailment)]
4041     ///
4042     /// trait Trait {
4043     ///     fn get<'s>(s: &'s str, _: &'static &'static ()) -> &'static str;
4044     /// }
4045     ///
4046     /// impl Trait for () {
4047     ///     fn get<'s>(s: &'s str, _: &'static &'s ()) -> &'static str {
4048     ///         s
4049     ///     }
4050     /// }
4051     ///
4052     /// let val = <() as Trait>::get(&String::from("blah blah blah"), &&());
4053     /// println!("{}", val);
4054     /// ```
4055     ///
4056     /// {{produces}}
4057     ///
4058     /// ### Explanation
4059     ///
4060     /// Neither the trait method, which provides no implied bounds about `'s`, nor the impl,
4061     /// requires the main function to prove that 's: 'static, but the impl method is allowed
4062     /// to assume that `'s: 'static` within its own body.
4063     ///
4064     /// This can be used to implement an unsound API if used incorrectly.
4065     pub IMPLIED_BOUNDS_ENTAILMENT,
4066     Deny,
4067     "impl method assumes more implied bounds than its corresponding trait method",
4068     @future_incompatible = FutureIncompatibleInfo {
4069         reference: "issue #105572 <https://github.com/rust-lang/rust/issues/105572>",
4070         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
4071     };
4072 }
4073
4074 declare_lint! {
4075     /// The `byte_slice_in_packed_struct_with_derive` lint detects cases where a byte slice field
4076     /// (`[u8]`) or string slice field (`str`) is used in a `packed` struct that derives one or
4077     /// more built-in traits.
4078     ///
4079     /// ### Example
4080     ///
4081     /// ```rust
4082     /// #[repr(packed)]
4083     /// #[derive(Hash)]
4084     /// struct FlexZeroSlice {
4085     ///     width: u8,
4086     ///     data: [u8],
4087     /// }
4088     /// ```
4089     ///
4090     /// {{produces}}
4091     ///
4092     /// ### Explanation
4093     ///
4094     /// This was previously accepted but is being phased out, because fields in packed structs are
4095     /// now required to implement `Copy` for `derive` to work. Byte slices and string slices are a
4096     /// temporary exception because certain crates depended on them.
4097     pub BYTE_SLICE_IN_PACKED_STRUCT_WITH_DERIVE,
4098     Warn,
4099     "`[u8]` or `str` used in a packed struct with `derive`",
4100     @future_incompatible = FutureIncompatibleInfo {
4101         reference: "issue #107457 <https://github.com/rust-lang/rust/issues/107457>",
4102         reason: FutureIncompatibilityReason::FutureReleaseErrorReportNow,
4103     };
4104     report_in_external_macro
4105 }