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//! When removing a lint, make sure to also add a call to `register_removed` in
8//! compiler/rustc_lint/src/lib.rs.
910use crate::{declare_lint, declare_lint_pass, fcw};
1112#[doc = r" Does nothing as a lint pass, but registers some `Lint`s"]
#[doc = r" that are used by other parts of the compiler."]
pub struct HardwiredLints;
#[automatically_derived]
impl ::core::marker::Copy for HardwiredLints { }
#[automatically_derived]
#[doc(hidden)]
unsafe impl ::core::clone::TrivialClone for HardwiredLints { }
#[automatically_derived]
impl ::core::clone::Clone for HardwiredLints {
#[inline]
fn clone(&self) -> HardwiredLints { *self }
}
impl crate::LintPass for HardwiredLints {
fn name(&self) -> &'static str { "HardwiredLints" }
fn get_lints(&self) -> crate::LintVec {
::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
[AARCH64_SOFTFLOAT_NEON,
ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
AMBIGUOUS_ASSOCIATED_ITEMS, AMBIGUOUS_DERIVE_HELPERS,
AMBIGUOUS_GLOB_IMPORTED_TRAITS, AMBIGUOUS_GLOB_IMPORTS,
AMBIGUOUS_GLOB_REEXPORTS, AMBIGUOUS_IMPORT_VISIBILITIES,
AMBIGUOUS_PANIC_IMPORTS, ARITHMETIC_OVERFLOW,
ASM_SUB_REGISTER, BAD_ASM_STYLE, BARE_TRAIT_OBJECTS,
BINDINGS_WITH_VARIANT_NAME, BREAK_WITH_LABEL_AND_LOOP,
COHERENCE_LEAK_CHECK, CONFLICTING_REPR_HINTS,
CONST_EVALUATABLE_UNCHECKED, CONST_ITEM_MUTATION, DEAD_CODE,
DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK, DEPRECATED,
DEPRECATED_IN_FUTURE, DEPRECATED_SAFE_2024,
DEPRECATED_WHERE_CLAUSE_LOCATION,
DUPLICATE_MACRO_ATTRIBUTES,
ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
ELIDED_LIFETIMES_IN_PATHS, EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
EXPORTED_PRIVATE_DEPENDENCIES, FFI_UNWIND_CALLS,
FORBIDDEN_LINT_GROUPS, FUNCTION_ITEM_REFERENCES,
FUZZY_PROVENANCE_CASTS, HIDDEN_GLOB_REEXPORTS,
ILL_FORMED_ATTRIBUTE_INPUT, INCOMPLETE_INCLUDE,
INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES,
INLINE_NO_SANITIZE, INVALID_DOC_ATTRIBUTES,
INVALID_MACRO_EXPORT_ARGUMENTS, INVALID_TYPE_PARAM_DEFAULT,
IRREFUTABLE_LET_PATTERNS, LARGE_ASSIGNMENTS,
LATE_BOUND_LIFETIME_ARGUMENTS, LEGACY_DERIVE_HELPERS,
LINKER_MESSAGES, LONG_RUNNING_CONST_EVAL,
LOSSY_PROVENANCE_CASTS,
MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
MACRO_USE_EXTERN_CRATE, MALFORMED_DIAGNOSTIC_ATTRIBUTES,
MALFORMED_DIAGNOSTIC_FORMAT_LITERALS, META_VARIABLE_MISUSE,
MISPLACED_DIAGNOSTIC_ATTRIBUTES, MISSING_ABI,
MISSING_UNSAFE_ON_EXTERN, MUST_NOT_SUSPEND,
NAMED_ARGUMENTS_USED_POSITIONALLY,
NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE,
NON_CONTIGUOUS_RANGE_ENDPOINTS,
NON_EXHAUSTIVE_OMITTED_PATTERNS, OUT_OF_SCOPE_MACRO_CALLS,
OVERLAPPING_RANGE_ENDPOINTS, PATTERNS_IN_FNS_WITHOUT_BODY,
PRIVATE_BOUNDS, PRIVATE_INTERFACES,
PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
PUB_USE_OF_PRIVATE_EXTERN_CRATE, REDUNDANT_IMPORTS,
REDUNDANT_LIFETIMES, REFINING_IMPL_TRAIT_INTERNAL,
REFINING_IMPL_TRAIT_REACHABLE, RENAMED_AND_REMOVED_LINTS,
REPR_C_ENUMS_LARGER_THAN_INT,
REPR_TRANSPARENT_NON_ZST_FIELDS,
RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS,
RTSAN_NONBLOCKING_ASYNC,
RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
RUST_2021_INCOMPATIBLE_OR_PATTERNS,
RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
RUST_2021_PRELUDE_COLLISIONS,
RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX,
RUST_2024_INCOMPATIBLE_PAT, RUST_2024_PRELUDE_COLLISIONS,
SELF_CONSTRUCTOR_FROM_OUTER_ITEM,
SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
SHADOWING_SUPERTRAIT_ITEMS, SINGLE_USE_LIFETIMES,
SOFT_UNSTABLE, STABLE_FEATURES, TAIL_EXPR_DROP_ORDER,
TEST_UNSTABLE_LINT, TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
TEXT_DIRECTION_CODEPOINT_IN_LITERAL, TRIVIAL_CASTS,
TRIVIAL_NUMERIC_CASTS, TYVAR_BEHIND_RAW_POINTER,
UNCONDITIONAL_PANIC, UNCONDITIONAL_RECURSION,
UNCOVERED_PARAM_IN_PROJECTION, UNEXPECTED_CFGS,
UNFULFILLED_LINT_EXPECTATIONS, UNINHABITED_STATIC,
UNKNOWN_CRATE_TYPES, UNKNOWN_DIAGNOSTIC_ATTRIBUTES,
UNKNOWN_LINTS, UNNAMEABLE_TEST_ITEMS, UNNAMEABLE_TYPES,
UNREACHABLE_CFG_SELECT_PREDICATES, UNREACHABLE_CODE,
UNREACHABLE_PATTERNS, UNSAFE_ATTR_OUTSIDE_UNSAFE,
UNSAFE_OP_IN_UNSAFE_FN, UNSTABLE_NAME_COLLISIONS,
UNSTABLE_SYNTAX_PRE_EXPANSION,
UNSUPPORTED_CALLING_CONVENTIONS, UNUSED_ASSIGNMENTS,
UNUSED_ASSOCIATED_TYPE_BOUNDS, UNUSED_ATTRIBUTES,
UNUSED_CRATE_DEPENDENCIES, UNUSED_EXTERN_CRATES,
UNUSED_FEATURES, UNUSED_IMPORTS, UNUSED_LABELS,
UNUSED_LIFETIMES, UNUSED_MACROS, UNUSED_MACRO_RULES,
UNUSED_MUT, UNUSED_QUALIFICATIONS, UNUSED_UNSAFE,
UNUSED_VARIABLES, UNUSED_VISIBILITIES, USELESS_DEPRECATED,
VARARGS_WITHOUT_PATTERN, WARNINGS]))
}
}
impl HardwiredLints {
#[allow(unused)]
pub fn lint_vec() -> crate::LintVec {
::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
[AARCH64_SOFTFLOAT_NEON,
ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
AMBIGUOUS_ASSOCIATED_ITEMS, AMBIGUOUS_DERIVE_HELPERS,
AMBIGUOUS_GLOB_IMPORTED_TRAITS, AMBIGUOUS_GLOB_IMPORTS,
AMBIGUOUS_GLOB_REEXPORTS, AMBIGUOUS_IMPORT_VISIBILITIES,
AMBIGUOUS_PANIC_IMPORTS, ARITHMETIC_OVERFLOW,
ASM_SUB_REGISTER, BAD_ASM_STYLE, BARE_TRAIT_OBJECTS,
BINDINGS_WITH_VARIANT_NAME, BREAK_WITH_LABEL_AND_LOOP,
COHERENCE_LEAK_CHECK, CONFLICTING_REPR_HINTS,
CONST_EVALUATABLE_UNCHECKED, CONST_ITEM_MUTATION, DEAD_CODE,
DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK, DEPRECATED,
DEPRECATED_IN_FUTURE, DEPRECATED_SAFE_2024,
DEPRECATED_WHERE_CLAUSE_LOCATION,
DUPLICATE_MACRO_ATTRIBUTES,
ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
ELIDED_LIFETIMES_IN_PATHS, EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
EXPORTED_PRIVATE_DEPENDENCIES, FFI_UNWIND_CALLS,
FORBIDDEN_LINT_GROUPS, FUNCTION_ITEM_REFERENCES,
FUZZY_PROVENANCE_CASTS, HIDDEN_GLOB_REEXPORTS,
ILL_FORMED_ATTRIBUTE_INPUT, INCOMPLETE_INCLUDE,
INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES,
INLINE_NO_SANITIZE, INVALID_DOC_ATTRIBUTES,
INVALID_MACRO_EXPORT_ARGUMENTS, INVALID_TYPE_PARAM_DEFAULT,
IRREFUTABLE_LET_PATTERNS, LARGE_ASSIGNMENTS,
LATE_BOUND_LIFETIME_ARGUMENTS, LEGACY_DERIVE_HELPERS,
LINKER_MESSAGES, LONG_RUNNING_CONST_EVAL,
LOSSY_PROVENANCE_CASTS,
MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
MACRO_USE_EXTERN_CRATE, MALFORMED_DIAGNOSTIC_ATTRIBUTES,
MALFORMED_DIAGNOSTIC_FORMAT_LITERALS, META_VARIABLE_MISUSE,
MISPLACED_DIAGNOSTIC_ATTRIBUTES, MISSING_ABI,
MISSING_UNSAFE_ON_EXTERN, MUST_NOT_SUSPEND,
NAMED_ARGUMENTS_USED_POSITIONALLY,
NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE,
NON_CONTIGUOUS_RANGE_ENDPOINTS,
NON_EXHAUSTIVE_OMITTED_PATTERNS, OUT_OF_SCOPE_MACRO_CALLS,
OVERLAPPING_RANGE_ENDPOINTS, PATTERNS_IN_FNS_WITHOUT_BODY,
PRIVATE_BOUNDS, PRIVATE_INTERFACES,
PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
PUB_USE_OF_PRIVATE_EXTERN_CRATE, REDUNDANT_IMPORTS,
REDUNDANT_LIFETIMES, REFINING_IMPL_TRAIT_INTERNAL,
REFINING_IMPL_TRAIT_REACHABLE, RENAMED_AND_REMOVED_LINTS,
REPR_C_ENUMS_LARGER_THAN_INT,
REPR_TRANSPARENT_NON_ZST_FIELDS,
RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS,
RTSAN_NONBLOCKING_ASYNC,
RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
RUST_2021_INCOMPATIBLE_OR_PATTERNS,
RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
RUST_2021_PRELUDE_COLLISIONS,
RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX,
RUST_2024_INCOMPATIBLE_PAT, RUST_2024_PRELUDE_COLLISIONS,
SELF_CONSTRUCTOR_FROM_OUTER_ITEM,
SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
SHADOWING_SUPERTRAIT_ITEMS, SINGLE_USE_LIFETIMES,
SOFT_UNSTABLE, STABLE_FEATURES, TAIL_EXPR_DROP_ORDER,
TEST_UNSTABLE_LINT, TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
TEXT_DIRECTION_CODEPOINT_IN_LITERAL, TRIVIAL_CASTS,
TRIVIAL_NUMERIC_CASTS, TYVAR_BEHIND_RAW_POINTER,
UNCONDITIONAL_PANIC, UNCONDITIONAL_RECURSION,
UNCOVERED_PARAM_IN_PROJECTION, UNEXPECTED_CFGS,
UNFULFILLED_LINT_EXPECTATIONS, UNINHABITED_STATIC,
UNKNOWN_CRATE_TYPES, UNKNOWN_DIAGNOSTIC_ATTRIBUTES,
UNKNOWN_LINTS, UNNAMEABLE_TEST_ITEMS, UNNAMEABLE_TYPES,
UNREACHABLE_CFG_SELECT_PREDICATES, UNREACHABLE_CODE,
UNREACHABLE_PATTERNS, UNSAFE_ATTR_OUTSIDE_UNSAFE,
UNSAFE_OP_IN_UNSAFE_FN, UNSTABLE_NAME_COLLISIONS,
UNSTABLE_SYNTAX_PRE_EXPANSION,
UNSUPPORTED_CALLING_CONVENTIONS, UNUSED_ASSIGNMENTS,
UNUSED_ASSOCIATED_TYPE_BOUNDS, UNUSED_ATTRIBUTES,
UNUSED_CRATE_DEPENDENCIES, UNUSED_EXTERN_CRATES,
UNUSED_FEATURES, UNUSED_IMPORTS, UNUSED_LABELS,
UNUSED_LIFETIMES, UNUSED_MACROS, UNUSED_MACRO_RULES,
UNUSED_MUT, UNUSED_QUALIFICATIONS, UNUSED_UNSAFE,
UNUSED_VARIABLES, UNUSED_VISIBILITIES, USELESS_DEPRECATED,
VARARGS_WITHOUT_PATTERN, WARNINGS]))
}
}declare_lint_pass! {
13/// Does nothing as a lint pass, but registers some `Lint`s
14 /// that are used by other parts of the compiler.
15HardwiredLints => [
16// tidy-alphabetical-start
17AARCH64_SOFTFLOAT_NEON,
18 ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
19 AMBIGUOUS_ASSOCIATED_ITEMS,
20 AMBIGUOUS_DERIVE_HELPERS,
21 AMBIGUOUS_GLOB_IMPORTED_TRAITS,
22 AMBIGUOUS_GLOB_IMPORTS,
23 AMBIGUOUS_GLOB_REEXPORTS,
24 AMBIGUOUS_IMPORT_VISIBILITIES,
25 AMBIGUOUS_PANIC_IMPORTS,
26 ARITHMETIC_OVERFLOW,
27 ASM_SUB_REGISTER,
28 BAD_ASM_STYLE,
29 BARE_TRAIT_OBJECTS,
30 BINDINGS_WITH_VARIANT_NAME,
31 BREAK_WITH_LABEL_AND_LOOP,
32 COHERENCE_LEAK_CHECK,
33 CONFLICTING_REPR_HINTS,
34 CONST_EVALUATABLE_UNCHECKED,
35 CONST_ITEM_MUTATION,
36 DEAD_CODE,
37 DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK,
38 DEPRECATED,
39 DEPRECATED_IN_FUTURE,
40 DEPRECATED_SAFE_2024,
41 DEPRECATED_WHERE_CLAUSE_LOCATION,
42 DUPLICATE_MACRO_ATTRIBUTES,
43 ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
44 ELIDED_LIFETIMES_IN_PATHS,
45 EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
46 EXPORTED_PRIVATE_DEPENDENCIES,
47 FFI_UNWIND_CALLS,
48 FORBIDDEN_LINT_GROUPS,
49 FUNCTION_ITEM_REFERENCES,
50 FUZZY_PROVENANCE_CASTS,
51 HIDDEN_GLOB_REEXPORTS,
52 ILL_FORMED_ATTRIBUTE_INPUT,
53 INCOMPLETE_INCLUDE,
54 INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
55 INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES,
56 INLINE_NO_SANITIZE,
57 INVALID_DOC_ATTRIBUTES,
58 INVALID_MACRO_EXPORT_ARGUMENTS,
59 INVALID_TYPE_PARAM_DEFAULT,
60 IRREFUTABLE_LET_PATTERNS,
61 LARGE_ASSIGNMENTS,
62 LATE_BOUND_LIFETIME_ARGUMENTS,
63 LEGACY_DERIVE_HELPERS,
64 LINKER_MESSAGES,
65 LONG_RUNNING_CONST_EVAL,
66 LOSSY_PROVENANCE_CASTS,
67 MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
68 MACRO_USE_EXTERN_CRATE,
69 MALFORMED_DIAGNOSTIC_ATTRIBUTES,
70 MALFORMED_DIAGNOSTIC_FORMAT_LITERALS,
71 META_VARIABLE_MISUSE,
72 MISPLACED_DIAGNOSTIC_ATTRIBUTES,
73 MISSING_ABI,
74 MISSING_UNSAFE_ON_EXTERN,
75 MUST_NOT_SUSPEND,
76 NAMED_ARGUMENTS_USED_POSITIONALLY,
77 NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE,
78 NON_CONTIGUOUS_RANGE_ENDPOINTS,
79 NON_EXHAUSTIVE_OMITTED_PATTERNS,
80 OUT_OF_SCOPE_MACRO_CALLS,
81 OVERLAPPING_RANGE_ENDPOINTS,
82 PATTERNS_IN_FNS_WITHOUT_BODY,
83 PRIVATE_BOUNDS,
84 PRIVATE_INTERFACES,
85 PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
86 PUB_USE_OF_PRIVATE_EXTERN_CRATE,
87 REDUNDANT_IMPORTS,
88 REDUNDANT_LIFETIMES,
89 REFINING_IMPL_TRAIT_INTERNAL,
90 REFINING_IMPL_TRAIT_REACHABLE,
91 RENAMED_AND_REMOVED_LINTS,
92 REPR_C_ENUMS_LARGER_THAN_INT,
93 REPR_TRANSPARENT_NON_ZST_FIELDS,
94 RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS,
95 RTSAN_NONBLOCKING_ASYNC,
96 RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
97 RUST_2021_INCOMPATIBLE_OR_PATTERNS,
98 RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
99 RUST_2021_PRELUDE_COLLISIONS,
100 RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX,
101 RUST_2024_INCOMPATIBLE_PAT,
102 RUST_2024_PRELUDE_COLLISIONS,
103 SELF_CONSTRUCTOR_FROM_OUTER_ITEM,
104 SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
105 SHADOWING_SUPERTRAIT_ITEMS,
106 SINGLE_USE_LIFETIMES,
107 SOFT_UNSTABLE,
108 STABLE_FEATURES,
109 TAIL_EXPR_DROP_ORDER,
110 TEST_UNSTABLE_LINT,
111 TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
112 TEXT_DIRECTION_CODEPOINT_IN_LITERAL,
113 TRIVIAL_CASTS,
114 TRIVIAL_NUMERIC_CASTS,
115 TYVAR_BEHIND_RAW_POINTER,
116 UNCONDITIONAL_PANIC,
117 UNCONDITIONAL_RECURSION,
118 UNCOVERED_PARAM_IN_PROJECTION,
119 UNEXPECTED_CFGS,
120 UNFULFILLED_LINT_EXPECTATIONS,
121 UNINHABITED_STATIC,
122 UNKNOWN_CRATE_TYPES,
123 UNKNOWN_DIAGNOSTIC_ATTRIBUTES,
124 UNKNOWN_LINTS,
125 UNNAMEABLE_TEST_ITEMS,
126 UNNAMEABLE_TYPES,
127 UNREACHABLE_CFG_SELECT_PREDICATES,
128 UNREACHABLE_CODE,
129 UNREACHABLE_PATTERNS,
130 UNSAFE_ATTR_OUTSIDE_UNSAFE,
131 UNSAFE_OP_IN_UNSAFE_FN,
132 UNSTABLE_NAME_COLLISIONS,
133 UNSTABLE_SYNTAX_PRE_EXPANSION,
134 UNSUPPORTED_CALLING_CONVENTIONS,
135 UNUSED_ASSIGNMENTS,
136 UNUSED_ASSOCIATED_TYPE_BOUNDS,
137 UNUSED_ATTRIBUTES,
138 UNUSED_CRATE_DEPENDENCIES,
139 UNUSED_EXTERN_CRATES,
140 UNUSED_FEATURES,
141 UNUSED_IMPORTS,
142 UNUSED_LABELS,
143 UNUSED_LIFETIMES,
144 UNUSED_MACROS,
145 UNUSED_MACRO_RULES,
146 UNUSED_MUT,
147 UNUSED_QUALIFICATIONS,
148 UNUSED_UNSAFE,
149 UNUSED_VARIABLES,
150 UNUSED_VISIBILITIES,
151 USELESS_DEPRECATED,
152 VARARGS_WITHOUT_PATTERN,
153 WARNINGS,
154// tidy-alphabetical-end
155]
156}157158#[doc = r" The `forbidden_lint_groups` lint detects violations of"]
#[doc = r" `forbid` applied to a lint group. Due to a bug in the compiler,"]
#[doc =
r" these used to be overlooked entirely. They now generate a warning."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![forbid(warnings)]"]
#[doc = r" #![warn(bad_style)]"]
#[doc = r""]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Recommended fix"]
#[doc = r""]
#[doc = r" If your crate is using `#![forbid(warnings)]`,"]
#[doc = r" we recommend that you change to `#![deny(warnings)]`."]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Due to a compiler bug, applying `forbid` to lint groups"]
#[doc = r" previously had no effect. The bug is now fixed but instead of"]
#[doc = r" enforcing `forbid` we issue this future-compatibility warning"]
#[doc = r" to avoid breaking existing crates."]
pub static FORBIDDEN_LINT_GROUPS: &crate::Lint =
&crate::Lint {
name: "FORBIDDEN_LINT_GROUPS",
default_level: crate::Warn,
desc: "applying forbid to lint-groups",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 81670,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
159/// The `forbidden_lint_groups` lint detects violations of
160 /// `forbid` applied to a lint group. Due to a bug in the compiler,
161 /// these used to be overlooked entirely. They now generate a warning.
162 ///
163 /// ### Example
164 ///
165 /// ```rust
166 /// #![forbid(warnings)]
167 /// #![warn(bad_style)]
168 ///
169 /// fn main() {}
170 /// ```
171 ///
172 /// {{produces}}
173 ///
174 /// ### Recommended fix
175 ///
176 /// If your crate is using `#![forbid(warnings)]`,
177 /// we recommend that you change to `#![deny(warnings)]`.
178 ///
179 /// ### Explanation
180 ///
181 /// Due to a compiler bug, applying `forbid` to lint groups
182 /// previously had no effect. The bug is now fixed but instead of
183 /// enforcing `forbid` we issue this future-compatibility warning
184 /// to avoid breaking existing crates.
185pub FORBIDDEN_LINT_GROUPS,
186 Warn,
187"applying forbid to lint-groups",
188 @future_incompatible = FutureIncompatibleInfo {
189 reason: fcw!(FutureReleaseError #81670),
190 report_in_deps: true,
191 };
192}193194#[doc =
r" The `ill_formed_attribute_input` lint detects ill-formed attribute"]
#[doc = r" inputs that were previously accepted and used in practice."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r#" #[inline = "this is not valid"]"#]
#[doc = r" fn foo() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Previously, inputs for many built-in attributes weren't validated and"]
#[doc = r" nonsensical attribute inputs were accepted. After validation was"]
#[doc =
r" added, it was determined that some existing projects made use of these"]
#[doc =
r" invalid forms. This is a [future-incompatible] lint to transition this"]
#[doc =
r" to a hard error in the future. See [issue #57571] for more details."]
#[doc = r""]
#[doc =
r" Check the [attribute reference] for details on the valid inputs for"]
#[doc = r" attributes."]
#[doc = r""]
#[doc = r" [issue #57571]: https://github.com/rust-lang/rust/issues/57571"]
#[doc =
r" [attribute reference]: https://doc.rust-lang.org/nightly/reference/attributes.html"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static ILL_FORMED_ATTRIBUTE_INPUT: &crate::Lint =
&crate::Lint {
name: "ILL_FORMED_ATTRIBUTE_INPUT",
default_level: crate::Deny,
desc: "ill-formed attribute inputs that were previously accepted and used in practice",
is_externally_loaded: false,
crate_level_only: true,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 57571,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
195/// The `ill_formed_attribute_input` lint detects ill-formed attribute
196 /// inputs that were previously accepted and used in practice.
197 ///
198 /// ### Example
199 ///
200 /// ```rust,compile_fail
201 /// #[inline = "this is not valid"]
202 /// fn foo() {}
203 /// ```
204 ///
205 /// {{produces}}
206 ///
207 /// ### Explanation
208 ///
209 /// Previously, inputs for many built-in attributes weren't validated and
210 /// nonsensical attribute inputs were accepted. After validation was
211 /// added, it was determined that some existing projects made use of these
212 /// invalid forms. This is a [future-incompatible] lint to transition this
213 /// to a hard error in the future. See [issue #57571] for more details.
214 ///
215 /// Check the [attribute reference] for details on the valid inputs for
216 /// attributes.
217 ///
218 /// [issue #57571]: https://github.com/rust-lang/rust/issues/57571
219 /// [attribute reference]: https://doc.rust-lang.org/nightly/reference/attributes.html
220 /// [future-incompatible]: ../index.md#future-incompatible-lints
221pub ILL_FORMED_ATTRIBUTE_INPUT,
222 Deny,
223"ill-formed attribute inputs that were previously accepted and used in practice",
224 @future_incompatible = FutureIncompatibleInfo {
225 reason: fcw!(FutureReleaseError #57571),
226 report_in_deps: true,
227 };
228 crate_level_only
229}230231#[doc =
r" The `conflicting_repr_hints` lint detects [`repr` attributes] with"]
#[doc = r" conflicting hints."]
#[doc = r""]
#[doc =
r" [`repr` attributes]: https://doc.rust-lang.org/reference/type-layout.html#representations"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #[repr(u32, u64)]"]
#[doc = r" enum Foo {"]
#[doc = r" Variant1,"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The compiler incorrectly accepted these conflicting representations in"]
#[doc =
r" the past. This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future. See [issue #68585] for more details."]
#[doc = r""]
#[doc = r" To correct the issue, remove one of the conflicting hints."]
#[doc = r""]
#[doc = r" [issue #68585]: https://github.com/rust-lang/rust/issues/68585"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static CONFLICTING_REPR_HINTS: &crate::Lint =
&crate::Lint {
name: "CONFLICTING_REPR_HINTS",
default_level: crate::Deny,
desc: "conflicts between `#[repr(..)]` hints that were previously accepted and used in practice",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 68585,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
232/// The `conflicting_repr_hints` lint detects [`repr` attributes] with
233 /// conflicting hints.
234 ///
235 /// [`repr` attributes]: https://doc.rust-lang.org/reference/type-layout.html#representations
236 ///
237 /// ### Example
238 ///
239 /// ```rust,compile_fail
240 /// #[repr(u32, u64)]
241 /// enum Foo {
242 /// Variant1,
243 /// }
244 /// ```
245 ///
246 /// {{produces}}
247 ///
248 /// ### Explanation
249 ///
250 /// The compiler incorrectly accepted these conflicting representations in
251 /// the past. This is a [future-incompatible] lint to transition this to a
252 /// hard error in the future. See [issue #68585] for more details.
253 ///
254 /// To correct the issue, remove one of the conflicting hints.
255 ///
256 /// [issue #68585]: https://github.com/rust-lang/rust/issues/68585
257 /// [future-incompatible]: ../index.md#future-incompatible-lints
258pub CONFLICTING_REPR_HINTS,
259 Deny,
260"conflicts between `#[repr(..)]` hints that were previously accepted and used in practice",
261 @future_incompatible = FutureIncompatibleInfo {
262 reason: fcw!(FutureReleaseError #68585),
263 report_in_deps: true,
264 };
265}266267#[doc =
r" The `meta_variable_misuse` lint detects possible meta-variable misuse"]
#[doc = r" in macro definitions."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(meta_variable_misuse)]"]
#[doc = r""]
#[doc = r" macro_rules! foo {"]
#[doc = r" () => {};"]
#[doc =
r" ($( $i:ident = $($j:ident),+ );*) => { $( $( $i = $k; )+ )* };"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" foo!();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" There are quite a few different ways a [`macro_rules`] macro can be"]
#[doc =
r" improperly defined. Many of these errors were previously only detected"]
#[doc =
r" when the macro was expanded or not at all. This lint is an attempt to"]
#[doc = r" catch some of these problems when the macro is *defined*."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because it may have false positives"#]
#[doc = r" and other issues. See [issue #61053] for more details."]
#[doc = r""]
#[doc =
r" [`macro_rules`]: https://doc.rust-lang.org/reference/macros-by-example.html"]
#[doc = r" [issue #61053]: https://github.com/rust-lang/rust/issues/61053"]
pub static META_VARIABLE_MISUSE: &crate::Lint =
&crate::Lint {
name: "META_VARIABLE_MISUSE",
default_level: crate::Allow,
desc: "possible meta-variable misuse at macro definition",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
268/// The `meta_variable_misuse` lint detects possible meta-variable misuse
269 /// in macro definitions.
270 ///
271 /// ### Example
272 ///
273 /// ```rust,compile_fail
274 /// #![deny(meta_variable_misuse)]
275 ///
276 /// macro_rules! foo {
277 /// () => {};
278 /// ($( $i:ident = $($j:ident),+ );*) => { $( $( $i = $k; )+ )* };
279 /// }
280 ///
281 /// fn main() {
282 /// foo!();
283 /// }
284 /// ```
285 ///
286 /// {{produces}}
287 ///
288 /// ### Explanation
289 ///
290 /// There are quite a few different ways a [`macro_rules`] macro can be
291 /// improperly defined. Many of these errors were previously only detected
292 /// when the macro was expanded or not at all. This lint is an attempt to
293 /// catch some of these problems when the macro is *defined*.
294 ///
295 /// This lint is "allow" by default because it may have false positives
296 /// and other issues. See [issue #61053] for more details.
297 ///
298 /// [`macro_rules`]: https://doc.rust-lang.org/reference/macros-by-example.html
299 /// [issue #61053]: https://github.com/rust-lang/rust/issues/61053
300pub META_VARIABLE_MISUSE,
301 Allow,
302"possible meta-variable misuse at macro definition"
303}304305#[doc = r" The `incomplete_include` lint detects the use of the [`include!`]"]
#[doc = r" macro with a file that contains more than one expression."]
#[doc = r""]
#[doc = r" [`include!`]: https://doc.rust-lang.org/std/macro.include.html"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs separate file)"]
#[doc = r" fn main() {"]
#[doc = r#" include!("foo.txt");"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" where the file `foo.txt` contains:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r#" println!("hi!");"#]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" produces:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" error: include macro expected single expression in source"]
#[doc = r" --> foo.txt:1:14"]
#[doc = r" |"]
#[doc = r#" 1 | println!("1");"#]
#[doc = r" | ^"]
#[doc = r" |"]
#[doc = r" = note: `#[deny(incomplete_include)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" The [`include!`] macro is currently only intended to be used to"]
#[doc =
r" include a single [expression] or multiple [items]. Historically it"]
#[doc =
r" would ignore any contents after the first expression, but that can be"]
#[doc =
r" confusing. In the example above, the `println!` expression ends just"]
#[doc =
r#" before the semicolon, making the semicolon "extra" information that is"#]
#[doc = r" ignored. Perhaps even more surprising, if the included file had"]
#[doc = r" multiple print statements, the subsequent ones would be ignored!"]
#[doc = r""]
#[doc =
r" One workaround is to place the contents in braces to create a [block"]
#[doc = r" expression]. Also consider alternatives, like using functions to"]
#[doc = r" encapsulate the expressions, or use [proc-macros]."]
#[doc = r""]
#[doc =
r" This is a lint instead of a hard error because existing projects were"]
#[doc =
r" found to hit this error. To be cautious, it is a lint for now. The"]
#[doc = r" future semantics of the `include!` macro are also uncertain, see"]
#[doc = r" [issue #35560]."]
#[doc = r""]
#[doc = r" [items]: https://doc.rust-lang.org/reference/items.html"]
#[doc =
r" [expression]: https://doc.rust-lang.org/reference/expressions.html"]
#[doc =
r" [block expression]: https://doc.rust-lang.org/reference/expressions/block-expr.html"]
#[doc =
r" [proc-macros]: https://doc.rust-lang.org/reference/procedural-macros.html"]
#[doc = r" [issue #35560]: https://github.com/rust-lang/rust/issues/35560"]
pub static INCOMPLETE_INCLUDE: &crate::Lint =
&crate::Lint {
name: "INCOMPLETE_INCLUDE",
default_level: crate::Deny,
desc: "trailing content in included file",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
306/// The `incomplete_include` lint detects the use of the [`include!`]
307 /// macro with a file that contains more than one expression.
308 ///
309 /// [`include!`]: https://doc.rust-lang.org/std/macro.include.html
310 ///
311 /// ### Example
312 ///
313 /// ```rust,ignore (needs separate file)
314 /// fn main() {
315 /// include!("foo.txt");
316 /// }
317 /// ```
318 ///
319 /// where the file `foo.txt` contains:
320 ///
321 /// ```text
322 /// println!("hi!");
323 /// ```
324 ///
325 /// produces:
326 ///
327 /// ```text
328 /// error: include macro expected single expression in source
329 /// --> foo.txt:1:14
330 /// |
331 /// 1 | println!("1");
332 /// | ^
333 /// |
334 /// = note: `#[deny(incomplete_include)]` on by default
335 /// ```
336 ///
337 /// ### Explanation
338 ///
339 /// The [`include!`] macro is currently only intended to be used to
340 /// include a single [expression] or multiple [items]. Historically it
341 /// would ignore any contents after the first expression, but that can be
342 /// confusing. In the example above, the `println!` expression ends just
343 /// before the semicolon, making the semicolon "extra" information that is
344 /// ignored. Perhaps even more surprising, if the included file had
345 /// multiple print statements, the subsequent ones would be ignored!
346 ///
347 /// One workaround is to place the contents in braces to create a [block
348 /// expression]. Also consider alternatives, like using functions to
349 /// encapsulate the expressions, or use [proc-macros].
350 ///
351 /// This is a lint instead of a hard error because existing projects were
352 /// found to hit this error. To be cautious, it is a lint for now. The
353 /// future semantics of the `include!` macro are also uncertain, see
354 /// [issue #35560].
355 ///
356 /// [items]: https://doc.rust-lang.org/reference/items.html
357 /// [expression]: https://doc.rust-lang.org/reference/expressions.html
358 /// [block expression]: https://doc.rust-lang.org/reference/expressions/block-expr.html
359 /// [proc-macros]: https://doc.rust-lang.org/reference/procedural-macros.html
360 /// [issue #35560]: https://github.com/rust-lang/rust/issues/35560
361pub INCOMPLETE_INCLUDE,
362 Deny,
363"trailing content in included file"
364}365366#[doc =
r" The `arithmetic_overflow` lint detects that an arithmetic operation"]
#[doc = r" will [overflow]."]
#[doc = r""]
#[doc =
r" [overflow]: https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" 1_i32 << 32;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is very likely a mistake to perform an arithmetic operation that"]
#[doc =
r" overflows its value. If the compiler is able to detect these kinds of"]
#[doc = r" overflows at compile-time, it will trigger this lint. Consider"]
#[doc =
r" adjusting the expression to avoid overflow, or use a data type that"]
#[doc = r" will not overflow."]
pub static ARITHMETIC_OVERFLOW: &crate::Lint =
&crate::Lint {
name: "ARITHMETIC_OVERFLOW",
default_level: crate::Deny,
desc: "arithmetic operation overflows",
is_externally_loaded: false,
eval_always: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
367/// The `arithmetic_overflow` lint detects that an arithmetic operation
368 /// will [overflow].
369 ///
370 /// [overflow]: https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow
371 ///
372 /// ### Example
373 ///
374 /// ```rust,compile_fail
375 /// 1_i32 << 32;
376 /// ```
377 ///
378 /// {{produces}}
379 ///
380 /// ### Explanation
381 ///
382 /// It is very likely a mistake to perform an arithmetic operation that
383 /// overflows its value. If the compiler is able to detect these kinds of
384 /// overflows at compile-time, it will trigger this lint. Consider
385 /// adjusting the expression to avoid overflow, or use a data type that
386 /// will not overflow.
387pub ARITHMETIC_OVERFLOW,
388 Deny,
389"arithmetic operation overflows",
390 @eval_always = true
391}392393#[doc =
r" The `unconditional_panic` lint detects an operation that will cause a"]
#[doc = r" panic at runtime."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" # #![allow(unused)]"]
#[doc = r" let x = 1 / 0;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This lint detects code that is very likely incorrect because it will"]
#[doc = r" always panic, such as division by zero and out-of-bounds array"]
#[doc =
r" accesses. Consider adjusting your code if this is a bug, or using the"]
#[doc =
r" `panic!` or `unreachable!` macro instead in case the panic is intended."]
pub static UNCONDITIONAL_PANIC: &crate::Lint =
&crate::Lint {
name: "UNCONDITIONAL_PANIC",
default_level: crate::Deny,
desc: "operation will cause a panic at runtime",
is_externally_loaded: false,
eval_always: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
394/// The `unconditional_panic` lint detects an operation that will cause a
395 /// panic at runtime.
396 ///
397 /// ### Example
398 ///
399 /// ```rust,compile_fail
400 /// # #![allow(unused)]
401 /// let x = 1 / 0;
402 /// ```
403 ///
404 /// {{produces}}
405 ///
406 /// ### Explanation
407 ///
408 /// This lint detects code that is very likely incorrect because it will
409 /// always panic, such as division by zero and out-of-bounds array
410 /// accesses. Consider adjusting your code if this is a bug, or using the
411 /// `panic!` or `unreachable!` macro instead in case the panic is intended.
412pub UNCONDITIONAL_PANIC,
413 Deny,
414"operation will cause a panic at runtime",
415 @eval_always = true
416}417418#[doc = r" The `unused_imports` lint detects imports that are never used."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" use std::collections::HashMap;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused imports may signal a mistake or unfinished code, and clutter"]
#[doc =
r" the code, and should be removed. If you intended to re-export the item"]
#[doc =
r" to make it available outside of the module, add a visibility modifier"]
#[doc = r" like `pub`."]
pub static UNUSED_IMPORTS: &crate::Lint =
&crate::Lint {
name: "UNUSED_IMPORTS",
default_level: crate::Warn,
desc: "imports that are never used",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
419/// The `unused_imports` lint detects imports that are never used.
420 ///
421 /// ### Example
422 ///
423 /// ```rust
424 /// use std::collections::HashMap;
425 /// ```
426 ///
427 /// {{produces}}
428 ///
429 /// ### Explanation
430 ///
431 /// Unused imports may signal a mistake or unfinished code, and clutter
432 /// the code, and should be removed. If you intended to re-export the item
433 /// to make it available outside of the module, add a visibility modifier
434 /// like `pub`.
435pub UNUSED_IMPORTS,
436 Warn,
437"imports that are never used"
438}439440#[doc =
r" The `redundant_imports` lint detects imports that are redundant due to being"]
#[doc =
r" imported already; either through a previous import, or being present in"]
#[doc = r" the prelude."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(redundant_imports)]"]
#[doc = r" use std::option::Option::None;"]
#[doc = r" fn foo() -> Option<i32> { None }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Redundant imports are unnecessary and can be removed to simplify code."]
#[doc =
r" If you intended to re-export the item to make it available outside of the"]
#[doc = r" module, add a visibility modifier like `pub`."]
pub static REDUNDANT_IMPORTS: &crate::Lint =
&crate::Lint {
name: "REDUNDANT_IMPORTS",
default_level: crate::Allow,
desc: "imports that are redundant due to being imported already",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
441/// The `redundant_imports` lint detects imports that are redundant due to being
442 /// imported already; either through a previous import, or being present in
443 /// the prelude.
444 ///
445 /// ### Example
446 ///
447 /// ```rust,compile_fail
448 /// #![deny(redundant_imports)]
449 /// use std::option::Option::None;
450 /// fn foo() -> Option<i32> { None }
451 /// ```
452 ///
453 /// {{produces}}
454 ///
455 /// ### Explanation
456 ///
457 /// Redundant imports are unnecessary and can be removed to simplify code.
458 /// If you intended to re-export the item to make it available outside of the
459 /// module, add a visibility modifier like `pub`.
460pub REDUNDANT_IMPORTS,
461 Allow,
462"imports that are redundant due to being imported already"
463}464465#[doc =
r" The `must_not_suspend` lint guards against values that shouldn't be held across suspend points"]
#[doc = r" (`.await`)"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![feature(must_not_suspend)]"]
#[doc = r" #![warn(must_not_suspend)]"]
#[doc = r""]
#[doc = r" #[must_not_suspend]"]
#[doc = r" struct SyncThing {}"]
#[doc = r""]
#[doc = r" async fn yield_now() {}"]
#[doc = r""]
#[doc = r" pub async fn uhoh() {"]
#[doc = r" let guard = SyncThing {};"]
#[doc = r" yield_now().await;"]
#[doc = r" let _guard = guard;"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The `must_not_suspend` lint detects values that are marked with the `#[must_not_suspend]`"]
#[doc =
r#" attribute being held across suspend points. A "suspend" point is usually a `.await` in an async"#]
#[doc = r" function."]
#[doc = r""]
#[doc =
r" This attribute can be used to mark values that are semantically incorrect across suspends"]
#[doc =
r" (like certain types of timers), values that have async alternatives, and values that"]
#[doc =
r" regularly cause problems with the `Send`-ness of async fn's returned futures (like"]
#[doc = r" `MutexGuard`'s)"]
#[doc = r""]
pub static MUST_NOT_SUSPEND: &crate::Lint =
&crate::Lint {
name: "MUST_NOT_SUSPEND",
default_level: crate::Allow,
desc: "use of a `#[must_not_suspend]` value across a yield point",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::must_not_suspend),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
466/// The `must_not_suspend` lint guards against values that shouldn't be held across suspend points
467 /// (`.await`)
468 ///
469 /// ### Example
470 ///
471 /// ```rust
472 /// #![feature(must_not_suspend)]
473 /// #![warn(must_not_suspend)]
474 ///
475 /// #[must_not_suspend]
476 /// struct SyncThing {}
477 ///
478 /// async fn yield_now() {}
479 ///
480 /// pub async fn uhoh() {
481 /// let guard = SyncThing {};
482 /// yield_now().await;
483 /// let _guard = guard;
484 /// }
485 /// ```
486 ///
487 /// {{produces}}
488 ///
489 /// ### Explanation
490 ///
491 /// The `must_not_suspend` lint detects values that are marked with the `#[must_not_suspend]`
492 /// attribute being held across suspend points. A "suspend" point is usually a `.await` in an async
493 /// function.
494 ///
495 /// This attribute can be used to mark values that are semantically incorrect across suspends
496 /// (like certain types of timers), values that have async alternatives, and values that
497 /// regularly cause problems with the `Send`-ness of async fn's returned futures (like
498 /// `MutexGuard`'s)
499 ///
500pub MUST_NOT_SUSPEND,
501 Allow,
502"use of a `#[must_not_suspend]` value across a yield point",
503 @feature_gate = must_not_suspend;
504}505506#[doc =
r" The `unused_extern_crates` lint guards against `extern crate` items"]
#[doc = r" that are never used."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(unused_extern_crates)]"]
#[doc = r" #![deny(warnings)]"]
#[doc = r" extern crate proc_macro;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" `extern crate` items that are unused have no effect and should be"]
#[doc =
r" removed. Note that there are some cases where specifying an `extern"]
#[doc =
r" crate` is desired for the side effect of ensuring the given crate is"]
#[doc =
r" linked, even though it is not otherwise directly referenced. The lint"]
#[doc = r" can be silenced by aliasing the crate to an underscore, such as"]
#[doc =
r" `extern crate foo as _`. Also note that it is no longer idiomatic to"]
#[doc =
r" use `extern crate` in the [2018 edition], as extern crates are now"]
#[doc = r" automatically added in scope."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because it can be noisy, and produce"#]
#[doc =
r" false-positives. If a dependency is being removed from a project, it"]
#[doc = r" is recommended to remove it from the build configuration (such as"]
#[doc = r" `Cargo.toml`) to ensure stale build entries aren't left behind."]
#[doc = r""]
#[doc =
r" [2018 edition]: https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-clarity.html#no-more-extern-crate"]
pub static UNUSED_EXTERN_CRATES: &crate::Lint =
&crate::Lint {
name: "UNUSED_EXTERN_CRATES",
default_level: crate::Allow,
desc: "extern crates that are never used",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
507/// The `unused_extern_crates` lint guards against `extern crate` items
508 /// that are never used.
509 ///
510 /// ### Example
511 ///
512 /// ```rust,compile_fail
513 /// #![deny(unused_extern_crates)]
514 /// #![deny(warnings)]
515 /// extern crate proc_macro;
516 /// ```
517 ///
518 /// {{produces}}
519 ///
520 /// ### Explanation
521 ///
522 /// `extern crate` items that are unused have no effect and should be
523 /// removed. Note that there are some cases where specifying an `extern
524 /// crate` is desired for the side effect of ensuring the given crate is
525 /// linked, even though it is not otherwise directly referenced. The lint
526 /// can be silenced by aliasing the crate to an underscore, such as
527 /// `extern crate foo as _`. Also note that it is no longer idiomatic to
528 /// use `extern crate` in the [2018 edition], as extern crates are now
529 /// automatically added in scope.
530 ///
531 /// This lint is "allow" by default because it can be noisy, and produce
532 /// false-positives. If a dependency is being removed from a project, it
533 /// is recommended to remove it from the build configuration (such as
534 /// `Cargo.toml`) to ensure stale build entries aren't left behind.
535 ///
536 /// [2018 edition]: https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-clarity.html#no-more-extern-crate
537pub UNUSED_EXTERN_CRATES,
538 Allow,
539"extern crates that are never used"
540}541542#[doc =
r" The `unused_crate_dependencies` lint detects crate dependencies that"]
#[doc = r" are never used."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs extern crate)"]
#[doc = r" #![deny(unused_crate_dependencies)]"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" error: extern crate `regex` is unused in crate `lint_example`"]
#[doc = r" |"]
#[doc =
r" = help: remove the dependency or add `use regex as _;` to the crate root"]
#[doc = r" note: the lint level is defined here"]
#[doc = r" --> src/lib.rs:1:9"]
#[doc = r" |"]
#[doc = r" 1 | #![deny(unused_crate_dependencies)]"]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" After removing the code that uses a dependency, this usually also"]
#[doc = r" requires removing the dependency from the build configuration."]
#[doc =
r" However, sometimes that step can be missed, which leads to time wasted"]
#[doc = r" building dependencies that are no longer used. This lint can be"]
#[doc =
r" enabled to detect dependencies that are never used (more specifically,"]
#[doc =
r" any dependency passed with the `--extern` command-line flag that is"]
#[doc =
r" never referenced via [`use`], [`extern crate`], or in any [path])."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because it can provide false positives"#]
#[doc =
r" depending on how the build system is configured. For example, when"]
#[doc = r#" using Cargo, a "package" consists of multiple crates (such as a"#]
#[doc = r" library and a binary), but the dependencies are defined for the"]
#[doc =
r" package as a whole. If there is a dependency that is only used in the"]
#[doc =
r" binary, but not the library, then the lint will be incorrectly issued"]
#[doc = r" in the library."]
#[doc = r""]
#[doc = r" [path]: https://doc.rust-lang.org/reference/paths.html"]
#[doc =
r" [`use`]: https://doc.rust-lang.org/reference/items/use-declarations.html"]
#[doc =
r" [`extern crate`]: https://doc.rust-lang.org/reference/items/extern-crates.html"]
pub static UNUSED_CRATE_DEPENDENCIES: &crate::Lint =
&crate::Lint {
name: "UNUSED_CRATE_DEPENDENCIES",
default_level: crate::Allow,
desc: "crate dependencies that are never used",
is_externally_loaded: false,
crate_level_only: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
543/// The `unused_crate_dependencies` lint detects crate dependencies that
544 /// are never used.
545 ///
546 /// ### Example
547 ///
548 /// ```rust,ignore (needs extern crate)
549 /// #![deny(unused_crate_dependencies)]
550 /// ```
551 ///
552 /// This will produce:
553 ///
554 /// ```text
555 /// error: extern crate `regex` is unused in crate `lint_example`
556 /// |
557 /// = help: remove the dependency or add `use regex as _;` to the crate root
558 /// note: the lint level is defined here
559 /// --> src/lib.rs:1:9
560 /// |
561 /// 1 | #![deny(unused_crate_dependencies)]
562 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^
563 /// ```
564 ///
565 /// ### Explanation
566 ///
567 /// After removing the code that uses a dependency, this usually also
568 /// requires removing the dependency from the build configuration.
569 /// However, sometimes that step can be missed, which leads to time wasted
570 /// building dependencies that are no longer used. This lint can be
571 /// enabled to detect dependencies that are never used (more specifically,
572 /// any dependency passed with the `--extern` command-line flag that is
573 /// never referenced via [`use`], [`extern crate`], or in any [path]).
574 ///
575 /// This lint is "allow" by default because it can provide false positives
576 /// depending on how the build system is configured. For example, when
577 /// using Cargo, a "package" consists of multiple crates (such as a
578 /// library and a binary), but the dependencies are defined for the
579 /// package as a whole. If there is a dependency that is only used in the
580 /// binary, but not the library, then the lint will be incorrectly issued
581 /// in the library.
582 ///
583 /// [path]: https://doc.rust-lang.org/reference/paths.html
584 /// [`use`]: https://doc.rust-lang.org/reference/items/use-declarations.html
585 /// [`extern crate`]: https://doc.rust-lang.org/reference/items/extern-crates.html
586pub UNUSED_CRATE_DEPENDENCIES,
587 Allow,
588"crate dependencies that are never used",
589 crate_level_only
590}591592#[doc = r" The `unused_qualifications` lint detects unnecessarily qualified"]
#[doc = r" names."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(unused_qualifications)]"]
#[doc = r" mod foo {"]
#[doc = r" pub fn bar() {}"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" use foo::bar;"]
#[doc = r" foo::bar();"]
#[doc = r" bar();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" If an item from another module is already brought into scope, then"]
#[doc = r" there is no need to qualify it in this case. You can call `bar()`"]
#[doc = r" directly, without the `foo::`."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because it is somewhat pedantic, and"#]
#[doc =
r" doesn't indicate an actual problem, but rather a stylistic choice, and"]
#[doc = r" can be noisy when refactoring or moving around code."]
pub static UNUSED_QUALIFICATIONS: &crate::Lint =
&crate::Lint {
name: "UNUSED_QUALIFICATIONS",
default_level: crate::Allow,
desc: "detects unnecessarily qualified names",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
593/// The `unused_qualifications` lint detects unnecessarily qualified
594 /// names.
595 ///
596 /// ### Example
597 ///
598 /// ```rust,compile_fail
599 /// #![deny(unused_qualifications)]
600 /// mod foo {
601 /// pub fn bar() {}
602 /// }
603 ///
604 /// fn main() {
605 /// use foo::bar;
606 /// foo::bar();
607 /// bar();
608 /// }
609 /// ```
610 ///
611 /// {{produces}}
612 ///
613 /// ### Explanation
614 ///
615 /// If an item from another module is already brought into scope, then
616 /// there is no need to qualify it in this case. You can call `bar()`
617 /// directly, without the `foo::`.
618 ///
619 /// This lint is "allow" by default because it is somewhat pedantic, and
620 /// doesn't indicate an actual problem, but rather a stylistic choice, and
621 /// can be noisy when refactoring or moving around code.
622pub UNUSED_QUALIFICATIONS,
623 Allow,
624"detects unnecessarily qualified names"
625}626627#[doc = r" The `unknown_lints` lint detects unrecognized lint attributes."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![allow(not_a_real_lint)]"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is usually a mistake to specify a lint that does not exist. Check"]
#[doc =
r" the spelling, and check the lint listing for the correct name. Also"]
#[doc =
r" consider if you are using an old version of the compiler, and the lint"]
#[doc = r" is only available in a newer version."]
pub static UNKNOWN_LINTS: &crate::Lint =
&crate::Lint {
name: "UNKNOWN_LINTS",
default_level: crate::Warn,
desc: "unrecognized lint attribute",
is_externally_loaded: false,
eval_always: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
628/// The `unknown_lints` lint detects unrecognized lint attributes.
629 ///
630 /// ### Example
631 ///
632 /// ```rust
633 /// #![allow(not_a_real_lint)]
634 /// ```
635 ///
636 /// {{produces}}
637 ///
638 /// ### Explanation
639 ///
640 /// It is usually a mistake to specify a lint that does not exist. Check
641 /// the spelling, and check the lint listing for the correct name. Also
642 /// consider if you are using an old version of the compiler, and the lint
643 /// is only available in a newer version.
644pub UNKNOWN_LINTS,
645 Warn,
646"unrecognized lint attribute",
647 @eval_always = true
648}649650#[doc =
r" The `unfulfilled_lint_expectations` lint detects when a lint expectation is"]
#[doc = r" unfulfilled."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #[expect(unused_variables)]"]
#[doc = r" let x = 10;"]
#[doc = r#" println!("{}", x);"#]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The `#[expect]` attribute can be used to create a lint expectation. The"]
#[doc =
r" expectation is fulfilled, if a `#[warn]` attribute at the same location"]
#[doc =
r" would result in a lint emission. If the expectation is unfulfilled,"]
#[doc =
r" because no lint was emitted, this lint will be emitted on the attribute."]
#[doc = r""]
pub static UNFULFILLED_LINT_EXPECTATIONS: &crate::Lint =
&crate::Lint {
name: "UNFULFILLED_LINT_EXPECTATIONS",
default_level: crate::Warn,
desc: "unfulfilled lint expectation",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
651/// The `unfulfilled_lint_expectations` lint detects when a lint expectation is
652 /// unfulfilled.
653 ///
654 /// ### Example
655 ///
656 /// ```rust
657 /// #[expect(unused_variables)]
658 /// let x = 10;
659 /// println!("{}", x);
660 /// ```
661 ///
662 /// {{produces}}
663 ///
664 /// ### Explanation
665 ///
666 /// The `#[expect]` attribute can be used to create a lint expectation. The
667 /// expectation is fulfilled, if a `#[warn]` attribute at the same location
668 /// would result in a lint emission. If the expectation is unfulfilled,
669 /// because no lint was emitted, this lint will be emitted on the attribute.
670 ///
671pub UNFULFILLED_LINT_EXPECTATIONS,
672 Warn,
673"unfulfilled lint expectation"
674}675676#[doc =
r" The `unused_variables` lint detects variables which are not used in"]
#[doc = r" any way."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" let x = 5;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused variables may signal a mistake or unfinished code. To silence"]
#[doc =
r" the warning for the individual variable, prefix it with an underscore"]
#[doc = r" such as `_x`."]
pub static UNUSED_VARIABLES: &crate::Lint =
&crate::Lint {
name: "UNUSED_VARIABLES",
default_level: crate::Warn,
desc: "detect variables which are not used in any way",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
677/// The `unused_variables` lint detects variables which are not used in
678 /// any way.
679 ///
680 /// ### Example
681 ///
682 /// ```rust
683 /// let x = 5;
684 /// ```
685 ///
686 /// {{produces}}
687 ///
688 /// ### Explanation
689 ///
690 /// Unused variables may signal a mistake or unfinished code. To silence
691 /// the warning for the individual variable, prefix it with an underscore
692 /// such as `_x`.
693pub UNUSED_VARIABLES,
694 Warn,
695"detect variables which are not used in any way"
696}697698#[doc =
r" The `unused_visibilities` lint detects visibility qualifiers (like `pub`)"]
#[doc = r" on a `const _` item."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" pub const _: () = {};"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" These qualifiers have no effect, as `const _` items are unnameable."]
pub static UNUSED_VISIBILITIES: &crate::Lint =
&crate::Lint {
name: "UNUSED_VISIBILITIES",
default_level: crate::Warn,
desc: "detect visibility qualifiers on `const _` items",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
699/// The `unused_visibilities` lint detects visibility qualifiers (like `pub`)
700 /// on a `const _` item.
701 ///
702 /// ### Example
703 ///
704 /// ```rust
705 /// pub const _: () = {};
706 /// ```
707 ///
708 /// {{produces}}
709 ///
710 /// ### Explanation
711 ///
712 /// These qualifiers have no effect, as `const _` items are unnameable.
713pub UNUSED_VISIBILITIES,
714 Warn,
715"detect visibility qualifiers on `const _` items"
716}717718#[doc =
r" The `unused_assignments` lint detects assignments that will never be read."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" let mut x = 5;"]
#[doc = r" x = 6;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused assignments may signal a mistake or unfinished code. If the"]
#[doc =
r" variable is never used after being assigned, then the assignment can"]
#[doc =
r" be removed. Variables with an underscore prefix such as `_x` will not"]
#[doc = r" trigger this lint."]
pub static UNUSED_ASSIGNMENTS: &crate::Lint =
&crate::Lint {
name: "UNUSED_ASSIGNMENTS",
default_level: crate::Warn,
desc: "detect assignments that will never be read",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
719/// The `unused_assignments` lint detects assignments that will never be read.
720 ///
721 /// ### Example
722 ///
723 /// ```rust
724 /// let mut x = 5;
725 /// x = 6;
726 /// ```
727 ///
728 /// {{produces}}
729 ///
730 /// ### Explanation
731 ///
732 /// Unused assignments may signal a mistake or unfinished code. If the
733 /// variable is never used after being assigned, then the assignment can
734 /// be removed. Variables with an underscore prefix such as `_x` will not
735 /// trigger this lint.
736pub UNUSED_ASSIGNMENTS,
737 Warn,
738"detect assignments that will never be read"
739}740741#[doc = r" The `dead_code` lint detects unused, unexported items."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" fn foo() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Dead code may signal a mistake or unfinished code. To silence the"]
#[doc =
r" warning for individual items, prefix the name with an underscore such"]
#[doc =
r" as `_foo`. If it was intended to expose the item outside of the crate,"]
#[doc = r" consider adding a visibility modifier like `pub`."]
#[doc = r""]
#[doc = r" To preserve the numbering of tuple structs with unused fields,"]
#[doc = r" change the unused fields to have unit type or use"]
#[doc = r" `PhantomData`."]
#[doc = r""]
#[doc = r" Otherwise consider removing the unused code."]
#[doc = r""]
#[doc = r" ### Limitations"]
#[doc = r""]
#[doc = r" Removing fields that are only used for side-effects and never"]
#[doc = r" read will result in behavioral changes. Examples of this"]
#[doc = r" include:"]
#[doc = r""]
#[doc = r" - If a field's value performs an action when it is dropped."]
#[doc = r" - If a field's type does not implement an auto trait"]
#[doc = r" (e.g. `Send`, `Sync`, `Unpin`)."]
#[doc = r""]
#[doc = r" For side-effects from dropping field values, this lint should"]
#[doc = r" be allowed on those fields. For side-effects from containing"]
#[doc = r" field types, `PhantomData` should be used."]
pub static DEAD_CODE: &crate::Lint =
&crate::Lint {
name: "DEAD_CODE",
default_level: crate::Warn,
desc: "detect unused, unexported items",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
742/// The `dead_code` lint detects unused, unexported items.
743 ///
744 /// ### Example
745 ///
746 /// ```rust
747 /// fn foo() {}
748 /// ```
749 ///
750 /// {{produces}}
751 ///
752 /// ### Explanation
753 ///
754 /// Dead code may signal a mistake or unfinished code. To silence the
755 /// warning for individual items, prefix the name with an underscore such
756 /// as `_foo`. If it was intended to expose the item outside of the crate,
757 /// consider adding a visibility modifier like `pub`.
758 ///
759 /// To preserve the numbering of tuple structs with unused fields,
760 /// change the unused fields to have unit type or use
761 /// `PhantomData`.
762 ///
763 /// Otherwise consider removing the unused code.
764 ///
765 /// ### Limitations
766 ///
767 /// Removing fields that are only used for side-effects and never
768 /// read will result in behavioral changes. Examples of this
769 /// include:
770 ///
771 /// - If a field's value performs an action when it is dropped.
772 /// - If a field's type does not implement an auto trait
773 /// (e.g. `Send`, `Sync`, `Unpin`).
774 ///
775 /// For side-effects from dropping field values, this lint should
776 /// be allowed on those fields. For side-effects from containing
777 /// field types, `PhantomData` should be used.
778pub DEAD_CODE,
779 Warn,
780"detect unused, unexported items"
781}782783#[doc =
r" The `unused_attributes` lint detects attributes that were not used by"]
#[doc = r" the compiler."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![ignore]"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused [attributes] may indicate the attribute is placed in the wrong"]
#[doc =
r" position. Consider removing it, or placing it in the correct position."]
#[doc =
r" Also consider if you intended to use an _inner attribute_ (with a `!`"]
#[doc =
r" such as `#![allow(unused)]`) which applies to the item the attribute"]
#[doc = r" is within, or an _outer attribute_ (without a `!` such as"]
#[doc = r" `#[allow(unused)]`) which applies to the item *following* the"]
#[doc = r" attribute."]
#[doc = r""]
#[doc = r" [attributes]: https://doc.rust-lang.org/reference/attributes.html"]
pub static UNUSED_ATTRIBUTES: &crate::Lint =
&crate::Lint {
name: "UNUSED_ATTRIBUTES",
default_level: crate::Warn,
desc: "detects attributes that were not used by the compiler",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
784/// The `unused_attributes` lint detects attributes that were not used by
785 /// the compiler.
786 ///
787 /// ### Example
788 ///
789 /// ```rust
790 /// #![ignore]
791 /// ```
792 ///
793 /// {{produces}}
794 ///
795 /// ### Explanation
796 ///
797 /// Unused [attributes] may indicate the attribute is placed in the wrong
798 /// position. Consider removing it, or placing it in the correct position.
799 /// Also consider if you intended to use an _inner attribute_ (with a `!`
800 /// such as `#![allow(unused)]`) which applies to the item the attribute
801 /// is within, or an _outer attribute_ (without a `!` such as
802 /// `#[allow(unused)]`) which applies to the item *following* the
803 /// attribute.
804 ///
805 /// [attributes]: https://doc.rust-lang.org/reference/attributes.html
806pub UNUSED_ATTRIBUTES,
807 Warn,
808"detects attributes that were not used by the compiler"
809}810811#[doc = r" The `unreachable_code` lint detects unreachable code paths."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,no_run"]
#[doc = r#" panic!("we never go past here!");"#]
#[doc = r""]
#[doc = r" let x = 5;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unreachable code may signal a mistake or unfinished code. If the code"]
#[doc = r" is no longer in use, consider removing it."]
pub static UNREACHABLE_CODE: &crate::Lint =
&crate::Lint {
name: "UNREACHABLE_CODE",
default_level: crate::Warn,
desc: "detects unreachable code paths",
is_externally_loaded: false,
report_in_external_macro: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
812/// The `unreachable_code` lint detects unreachable code paths.
813 ///
814 /// ### Example
815 ///
816 /// ```rust,no_run
817 /// panic!("we never go past here!");
818 ///
819 /// let x = 5;
820 /// ```
821 ///
822 /// {{produces}}
823 ///
824 /// ### Explanation
825 ///
826 /// Unreachable code may signal a mistake or unfinished code. If the code
827 /// is no longer in use, consider removing it.
828pub UNREACHABLE_CODE,
829 Warn,
830"detects unreachable code paths",
831 report_in_external_macro
832}833834#[doc = r" The `unreachable_patterns` lint detects unreachable patterns."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" let x = 5;"]
#[doc = r" match x {"]
#[doc = r" y => (),"]
#[doc = r" 5 => (),"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This usually indicates a mistake in how the patterns are specified or"]
#[doc =
r" ordered. In this example, the `y` pattern will always match, so the"]
#[doc =
r" five is impossible to reach. Remember, match arms match in order, you"]
#[doc = r" probably wanted to put the `5` case above the `y` case."]
pub static UNREACHABLE_PATTERNS: &crate::Lint =
&crate::Lint {
name: "UNREACHABLE_PATTERNS",
default_level: crate::Warn,
desc: "detects unreachable patterns",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
835/// The `unreachable_patterns` lint detects unreachable patterns.
836 ///
837 /// ### Example
838 ///
839 /// ```rust
840 /// let x = 5;
841 /// match x {
842 /// y => (),
843 /// 5 => (),
844 /// }
845 /// ```
846 ///
847 /// {{produces}}
848 ///
849 /// ### Explanation
850 ///
851 /// This usually indicates a mistake in how the patterns are specified or
852 /// ordered. In this example, the `y` pattern will always match, so the
853 /// five is impossible to reach. Remember, match arms match in order, you
854 /// probably wanted to put the `5` case above the `y` case.
855pub UNREACHABLE_PATTERNS,
856 Warn,
857"detects unreachable patterns"
858}859860#[doc =
r" The `unreachable_cfg_select_predicates` lint detects unreachable configuration"]
#[doc = r" predicates in the `cfg_select!` macro."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![feature(cfg_select)]"]
#[doc = r" cfg_select! {"]
#[doc = r" _ => (),"]
#[doc = r" windows => (),"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This usually indicates a mistake in how the predicates are specified or"]
#[doc =
r" ordered. In this example, the `_` predicate will always match, so the"]
#[doc =
r" `windows` is impossible to reach. Remember, arms match in order, you"]
#[doc = r" probably wanted to put the `windows` case above the `_` case."]
pub static UNREACHABLE_CFG_SELECT_PREDICATES: &crate::Lint =
&crate::Lint {
name: "UNREACHABLE_CFG_SELECT_PREDICATES",
default_level: crate::Warn,
desc: "detects unreachable configuration predicates in the cfg_select macro",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::cfg_select),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
861/// The `unreachable_cfg_select_predicates` lint detects unreachable configuration
862 /// predicates in the `cfg_select!` macro.
863 ///
864 /// ### Example
865 ///
866 /// ```rust
867 /// #![feature(cfg_select)]
868 /// cfg_select! {
869 /// _ => (),
870 /// windows => (),
871 /// }
872 /// ```
873 ///
874 /// {{produces}}
875 ///
876 /// ### Explanation
877 ///
878 /// This usually indicates a mistake in how the predicates are specified or
879 /// ordered. In this example, the `_` predicate will always match, so the
880 /// `windows` is impossible to reach. Remember, arms match in order, you
881 /// probably wanted to put the `windows` case above the `_` case.
882pub UNREACHABLE_CFG_SELECT_PREDICATES,
883 Warn,
884"detects unreachable configuration predicates in the cfg_select macro",
885 @feature_gate = cfg_select;
886}887888#[doc =
r" The `overlapping_range_endpoints` lint detects `match` arms that have [range patterns] that"]
#[doc = r" overlap on their endpoints."]
#[doc = r""]
#[doc =
r" [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" let x = 123u8;"]
#[doc = r" match x {"]
#[doc = r#" 0..=100 => { println!("small"); }"#]
#[doc = r#" 100..=255 => { println!("large"); }"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is likely a mistake to have range patterns in a match expression that overlap in this"]
#[doc =
r" way. Check that the beginning and end values are what you expect, and keep in mind that"]
#[doc = r" with `..=` the left and right bounds are inclusive."]
pub static OVERLAPPING_RANGE_ENDPOINTS: &crate::Lint =
&crate::Lint {
name: "OVERLAPPING_RANGE_ENDPOINTS",
default_level: crate::Warn,
desc: "detects range patterns with overlapping endpoints",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
889/// The `overlapping_range_endpoints` lint detects `match` arms that have [range patterns] that
890 /// overlap on their endpoints.
891 ///
892 /// [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns
893 ///
894 /// ### Example
895 ///
896 /// ```rust
897 /// let x = 123u8;
898 /// match x {
899 /// 0..=100 => { println!("small"); }
900 /// 100..=255 => { println!("large"); }
901 /// }
902 /// ```
903 ///
904 /// {{produces}}
905 ///
906 /// ### Explanation
907 ///
908 /// It is likely a mistake to have range patterns in a match expression that overlap in this
909 /// way. Check that the beginning and end values are what you expect, and keep in mind that
910 /// with `..=` the left and right bounds are inclusive.
911pub OVERLAPPING_RANGE_ENDPOINTS,
912 Warn,
913"detects range patterns with overlapping endpoints"
914}915916#[doc =
r" The `non_contiguous_range_endpoints` lint detects likely off-by-one errors when using"]
#[doc = r" exclusive [range patterns]."]
#[doc = r""]
#[doc =
r" [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" let x = 123u32;"]
#[doc = r" match x {"]
#[doc = r#" 0..100 => { println!("small"); }"#]
#[doc = r#" 101..1000 => { println!("large"); }"#]
#[doc = r#" _ => { println!("larger"); }"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is likely a mistake to have range patterns in a match expression that miss out a single"]
#[doc =
r" number. Check that the beginning and end values are what you expect, and keep in mind that"]
#[doc =
r" with `..=` the right bound is inclusive, and with `..` it is exclusive."]
pub static NON_CONTIGUOUS_RANGE_ENDPOINTS: &crate::Lint =
&crate::Lint {
name: "NON_CONTIGUOUS_RANGE_ENDPOINTS",
default_level: crate::Warn,
desc: "detects off-by-one errors with exclusive range patterns",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
917/// The `non_contiguous_range_endpoints` lint detects likely off-by-one errors when using
918 /// exclusive [range patterns].
919 ///
920 /// [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns
921 ///
922 /// ### Example
923 ///
924 /// ```rust
925 /// let x = 123u32;
926 /// match x {
927 /// 0..100 => { println!("small"); }
928 /// 101..1000 => { println!("large"); }
929 /// _ => { println!("larger"); }
930 /// }
931 /// ```
932 ///
933 /// {{produces}}
934 ///
935 /// ### Explanation
936 ///
937 /// It is likely a mistake to have range patterns in a match expression that miss out a single
938 /// number. Check that the beginning and end values are what you expect, and keep in mind that
939 /// with `..=` the right bound is inclusive, and with `..` it is exclusive.
940pub NON_CONTIGUOUS_RANGE_ENDPOINTS,
941 Warn,
942"detects off-by-one errors with exclusive range patterns"
943}944945#[doc =
r" The `bindings_with_variant_name` lint detects pattern bindings with"]
#[doc = r" the same name as one of the matched variants."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" pub enum Enum {"]
#[doc = r" Foo,"]
#[doc = r" Bar,"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" pub fn foo(x: Enum) {"]
#[doc = r" match x {"]
#[doc = r" Foo => {}"]
#[doc = r" Bar => {}"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" It is usually a mistake to specify an enum variant name as an"]
#[doc = r" [identifier pattern]. In the example above, the `match` arms are"]
#[doc =
r" specifying a variable name to bind the value of `x` to. The second arm"]
#[doc = r" is ignored because the first one matches *all* values. The likely"]
#[doc = r" intent is that the arm was intended to match on the enum variant."]
#[doc = r""]
#[doc = r" Two possible solutions are:"]
#[doc = r""]
#[doc = r" * Specify the enum variant using a [path pattern], such as"]
#[doc = r" `Enum::Foo`."]
#[doc = r" * Bring the enum variants into local scope, such as adding `use"]
#[doc = r" Enum::*;` to the beginning of the `foo` function in the example"]
#[doc = r" above."]
#[doc = r""]
#[doc =
r" [identifier pattern]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns"]
#[doc =
r" [path pattern]: https://doc.rust-lang.org/reference/patterns.html#path-patterns"]
pub static BINDINGS_WITH_VARIANT_NAME: &crate::Lint =
&crate::Lint {
name: "BINDINGS_WITH_VARIANT_NAME",
default_level: crate::Deny,
desc: "detects pattern bindings with the same name as one of the matched variants",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
946/// The `bindings_with_variant_name` lint detects pattern bindings with
947 /// the same name as one of the matched variants.
948 ///
949 /// ### Example
950 ///
951 /// ```rust,compile_fail
952 /// pub enum Enum {
953 /// Foo,
954 /// Bar,
955 /// }
956 ///
957 /// pub fn foo(x: Enum) {
958 /// match x {
959 /// Foo => {}
960 /// Bar => {}
961 /// }
962 /// }
963 /// ```
964 ///
965 /// {{produces}}
966 ///
967 /// ### Explanation
968 ///
969 /// It is usually a mistake to specify an enum variant name as an
970 /// [identifier pattern]. In the example above, the `match` arms are
971 /// specifying a variable name to bind the value of `x` to. The second arm
972 /// is ignored because the first one matches *all* values. The likely
973 /// intent is that the arm was intended to match on the enum variant.
974 ///
975 /// Two possible solutions are:
976 ///
977 /// * Specify the enum variant using a [path pattern], such as
978 /// `Enum::Foo`.
979 /// * Bring the enum variants into local scope, such as adding `use
980 /// Enum::*;` to the beginning of the `foo` function in the example
981 /// above.
982 ///
983 /// [identifier pattern]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
984 /// [path pattern]: https://doc.rust-lang.org/reference/patterns.html#path-patterns
985pub BINDINGS_WITH_VARIANT_NAME,
986 Deny,
987"detects pattern bindings with the same name as one of the matched variants"
988}989990#[doc = r" The `unused_macros` lint detects macros that were not used."]
#[doc = r""]
#[doc =
r" Note that this lint is distinct from the `unused_macro_rules` lint,"]
#[doc =
r" which checks for single rules that never match of an otherwise used"]
#[doc = r" macro, and thus never expand."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" macro_rules! unused {"]
#[doc = r" () => {};"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused macros may signal a mistake or unfinished code. To silence the"]
#[doc =
r" warning for the individual macro, prefix the name with an underscore"]
#[doc =
r" such as `_my_macro`. If you intended to export the macro to make it"]
#[doc =
r" available outside of the crate, use the [`macro_export` attribute]."]
#[doc = r""]
#[doc =
r" [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope"]
pub static UNUSED_MACROS: &crate::Lint =
&crate::Lint {
name: "UNUSED_MACROS",
default_level: crate::Warn,
desc: "detects macros that were not used",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
991/// The `unused_macros` lint detects macros that were not used.
992 ///
993 /// Note that this lint is distinct from the `unused_macro_rules` lint,
994 /// which checks for single rules that never match of an otherwise used
995 /// macro, and thus never expand.
996 ///
997 /// ### Example
998 ///
999 /// ```rust
1000 /// macro_rules! unused {
1001 /// () => {};
1002 /// }
1003 ///
1004 /// fn main() {
1005 /// }
1006 /// ```
1007 ///
1008 /// {{produces}}
1009 ///
1010 /// ### Explanation
1011 ///
1012 /// Unused macros may signal a mistake or unfinished code. To silence the
1013 /// warning for the individual macro, prefix the name with an underscore
1014 /// such as `_my_macro`. If you intended to export the macro to make it
1015 /// available outside of the crate, use the [`macro_export` attribute].
1016 ///
1017 /// [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
1018pub UNUSED_MACROS,
1019 Warn,
1020"detects macros that were not used"
1021}10221023#[doc =
r" The `unused_macro_rules` lint detects macro rules that were not used."]
#[doc = r""]
#[doc =
r" Note that the lint is distinct from the `unused_macros` lint, which"]
#[doc =
r" fires if the entire macro is never called, while this lint fires for"]
#[doc = r" single unused rules of the macro that is otherwise used."]
#[doc = r" `unused_macro_rules` fires only if `unused_macros` wouldn't fire."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #[warn(unused_macro_rules)]"]
#[doc = r" macro_rules! unused_empty {"]
#[doc =
r#" (hello) => { println!("Hello, world!") }; // This rule is unused"#]
#[doc = r#" () => { println!("empty") }; // This rule is used"#]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" unused_empty!(hello);"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused macro rules may signal a mistake or unfinished code. Furthermore,"]
#[doc =
r" they slow down compilation. Right now, silencing the warning is not"]
#[doc =
r" supported on a single rule level, so you have to add an allow to the"]
#[doc = r" entire macro definition."]
#[doc = r""]
#[doc = r" If you intended to export the macro to make it"]
#[doc =
r" available outside of the crate, use the [`macro_export` attribute]."]
#[doc = r""]
#[doc =
r" [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope"]
pub static UNUSED_MACRO_RULES: &crate::Lint =
&crate::Lint {
name: "UNUSED_MACRO_RULES",
default_level: crate::Allow,
desc: "detects macro rules that were not used",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1024/// The `unused_macro_rules` lint detects macro rules that were not used.
1025 ///
1026 /// Note that the lint is distinct from the `unused_macros` lint, which
1027 /// fires if the entire macro is never called, while this lint fires for
1028 /// single unused rules of the macro that is otherwise used.
1029 /// `unused_macro_rules` fires only if `unused_macros` wouldn't fire.
1030 ///
1031 /// ### Example
1032 ///
1033 /// ```rust
1034 /// #[warn(unused_macro_rules)]
1035 /// macro_rules! unused_empty {
1036 /// (hello) => { println!("Hello, world!") }; // This rule is unused
1037 /// () => { println!("empty") }; // This rule is used
1038 /// }
1039 ///
1040 /// fn main() {
1041 /// unused_empty!(hello);
1042 /// }
1043 /// ```
1044 ///
1045 /// {{produces}}
1046 ///
1047 /// ### Explanation
1048 ///
1049 /// Unused macro rules may signal a mistake or unfinished code. Furthermore,
1050 /// they slow down compilation. Right now, silencing the warning is not
1051 /// supported on a single rule level, so you have to add an allow to the
1052 /// entire macro definition.
1053 ///
1054 /// If you intended to export the macro to make it
1055 /// available outside of the crate, use the [`macro_export` attribute].
1056 ///
1057 /// [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
1058pub UNUSED_MACRO_RULES,
1059 Allow,
1060"detects macro rules that were not used"
1061}10621063#[doc = r" The `warnings` lint allows you to change the level of other"]
#[doc = r" lints which produce warnings."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![deny(warnings)]"]
#[doc = r" fn foo() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" The `warnings` lint is a bit special; by changing its level, you"]
#[doc =
r" change every other warning that would produce a warning to whatever"]
#[doc =
r" value you'd like. As such, you won't ever trigger this lint in your"]
#[doc = r" code directly."]
pub static WARNINGS: &crate::Lint =
&crate::Lint {
name: "WARNINGS",
default_level: crate::Warn,
desc: "mass-change the level for lints which produce warnings",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1064/// The `warnings` lint allows you to change the level of other
1065 /// lints which produce warnings.
1066 ///
1067 /// ### Example
1068 ///
1069 /// ```rust
1070 /// #![deny(warnings)]
1071 /// fn foo() {}
1072 /// ```
1073 ///
1074 /// {{produces}}
1075 ///
1076 /// ### Explanation
1077 ///
1078 /// The `warnings` lint is a bit special; by changing its level, you
1079 /// change every other warning that would produce a warning to whatever
1080 /// value you'd like. As such, you won't ever trigger this lint in your
1081 /// code directly.
1082pub WARNINGS,
1083 Warn,
1084"mass-change the level for lints which produce warnings"
1085}10861087#[doc =
r" The `unused_features` lint detects unused or unknown features found in"]
#[doc = r" crate-level [`feature` attributes]."]
#[doc = r""]
#[doc =
r" [`feature` attributes]: https://doc.rust-lang.org/nightly/unstable-book/"]
#[doc = r""]
#[doc =
r" Note: This lint is currently not functional, see [issue #44232] for"]
#[doc = r" more details."]
#[doc = r""]
#[doc = r" [issue #44232]: https://github.com/rust-lang/rust/issues/44232"]
pub static UNUSED_FEATURES: &crate::Lint =
&crate::Lint {
name: "UNUSED_FEATURES",
default_level: crate::Warn,
desc: "unused features found in crate-level `#[feature]` directives",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1088/// The `unused_features` lint detects unused or unknown features found in
1089 /// crate-level [`feature` attributes].
1090 ///
1091 /// [`feature` attributes]: https://doc.rust-lang.org/nightly/unstable-book/
1092 ///
1093 /// Note: This lint is currently not functional, see [issue #44232] for
1094 /// more details.
1095 ///
1096 /// [issue #44232]: https://github.com/rust-lang/rust/issues/44232
1097pub UNUSED_FEATURES,
1098 Warn,
1099"unused features found in crate-level `#[feature]` directives"
1100}11011102#[doc = r" The `stable_features` lint detects a [`feature` attribute] that"]
#[doc = r" has since been made stable."]
#[doc = r""]
#[doc =
r" [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![feature(test_accepted_feature)]"]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" When a feature is stabilized, it is no longer necessary to include a"]
#[doc = r" `#![feature]` attribute for it. To fix, simply remove the"]
#[doc = r" `#![feature]` attribute."]
pub static STABLE_FEATURES: &crate::Lint =
&crate::Lint {
name: "STABLE_FEATURES",
default_level: crate::Warn,
desc: "stable features found in `#[feature]` directive",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1103/// The `stable_features` lint detects a [`feature` attribute] that
1104 /// has since been made stable.
1105 ///
1106 /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
1107 ///
1108 /// ### Example
1109 ///
1110 /// ```rust
1111 /// #![feature(test_accepted_feature)]
1112 /// fn main() {}
1113 /// ```
1114 ///
1115 /// {{produces}}
1116 ///
1117 /// ### Explanation
1118 ///
1119 /// When a feature is stabilized, it is no longer necessary to include a
1120 /// `#![feature]` attribute for it. To fix, simply remove the
1121 /// `#![feature]` attribute.
1122pub STABLE_FEATURES,
1123 Warn,
1124"stable features found in `#[feature]` directive"
1125}11261127#[doc =
r" The `unknown_crate_types` lint detects an unknown crate type found in"]
#[doc = r" a [`crate_type` attribute]."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r#" #![crate_type="lol"]"#]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" An unknown value give to the `crate_type` attribute is almost"]
#[doc = r" certainly a mistake."]
#[doc = r""]
#[doc =
r" [`crate_type` attribute]: https://doc.rust-lang.org/reference/linkage.html"]
pub static UNKNOWN_CRATE_TYPES: &crate::Lint =
&crate::Lint {
name: "UNKNOWN_CRATE_TYPES",
default_level: crate::Deny,
desc: "unknown crate type found in `#[crate_type]` directive",
is_externally_loaded: false,
crate_level_only: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1128/// The `unknown_crate_types` lint detects an unknown crate type found in
1129 /// a [`crate_type` attribute].
1130 ///
1131 /// ### Example
1132 ///
1133 /// ```rust,compile_fail
1134 /// #![crate_type="lol"]
1135 /// fn main() {}
1136 /// ```
1137 ///
1138 /// {{produces}}
1139 ///
1140 /// ### Explanation
1141 ///
1142 /// An unknown value give to the `crate_type` attribute is almost
1143 /// certainly a mistake.
1144 ///
1145 /// [`crate_type` attribute]: https://doc.rust-lang.org/reference/linkage.html
1146pub UNKNOWN_CRATE_TYPES,
1147 Deny,
1148"unknown crate type found in `#[crate_type]` directive",
1149 crate_level_only
1150}11511152#[doc =
r" The `trivial_casts` lint detects trivial casts which could be replaced"]
#[doc = r" with coercion, which may require a temporary variable."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(trivial_casts)]"]
#[doc = r" let x: &u32 = &42;"]
#[doc = r" let y = x as *const u32;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" A trivial cast is a cast `e as T` where `e` has type `U` and `U` is a"]
#[doc =
r" subtype of `T`. This type of cast is usually unnecessary, as it can be"]
#[doc = r" usually be inferred."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because there are situations, such as"#]
#[doc = r" with FFI interfaces or complex type aliases, where it triggers"]
#[doc = r" incorrectly, or in situations where it will be more difficult to"]
#[doc =
r" clearly express the intent. It may be possible that this will become a"]
#[doc =
r" warning in the future, possibly with an explicit syntax for coercions"]
#[doc = r" providing a convenient way to work around the current issues."]
#[doc =
r" See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and"]
#[doc =
r" [RFC 3307 (remove type ascription)][rfc-3307] for historical context."]
#[doc = r""]
#[doc =
r" [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md"]
#[doc =
r" [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md"]
#[doc =
r" [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md"]
pub static TRIVIAL_CASTS: &crate::Lint =
&crate::Lint {
name: "TRIVIAL_CASTS",
default_level: crate::Allow,
desc: "detects trivial casts which could be removed",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1153/// The `trivial_casts` lint detects trivial casts which could be replaced
1154 /// with coercion, which may require a temporary variable.
1155 ///
1156 /// ### Example
1157 ///
1158 /// ```rust,compile_fail
1159 /// #![deny(trivial_casts)]
1160 /// let x: &u32 = &42;
1161 /// let y = x as *const u32;
1162 /// ```
1163 ///
1164 /// {{produces}}
1165 ///
1166 /// ### Explanation
1167 ///
1168 /// A trivial cast is a cast `e as T` where `e` has type `U` and `U` is a
1169 /// subtype of `T`. This type of cast is usually unnecessary, as it can be
1170 /// usually be inferred.
1171 ///
1172 /// This lint is "allow" by default because there are situations, such as
1173 /// with FFI interfaces or complex type aliases, where it triggers
1174 /// incorrectly, or in situations where it will be more difficult to
1175 /// clearly express the intent. It may be possible that this will become a
1176 /// warning in the future, possibly with an explicit syntax for coercions
1177 /// providing a convenient way to work around the current issues.
1178 /// See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and
1179 /// [RFC 3307 (remove type ascription)][rfc-3307] for historical context.
1180 ///
1181 /// [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
1182 /// [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md
1183 /// [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md
1184pub TRIVIAL_CASTS,
1185 Allow,
1186"detects trivial casts which could be removed"
1187}11881189#[doc =
r" The `trivial_numeric_casts` lint detects trivial numeric casts of types"]
#[doc = r" which could be removed."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(trivial_numeric_casts)]"]
#[doc = r" let x = 42_i32 as i32;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" A trivial numeric cast is a cast of a numeric type to the same numeric"]
#[doc = r" type. This type of cast is usually unnecessary."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because there are situations, such as"#]
#[doc = r" with FFI interfaces or complex type aliases, where it triggers"]
#[doc = r" incorrectly, or in situations where it will be more difficult to"]
#[doc =
r" clearly express the intent. It may be possible that this will become a"]
#[doc =
r" warning in the future, possibly with an explicit syntax for coercions"]
#[doc = r" providing a convenient way to work around the current issues."]
#[doc =
r" See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and"]
#[doc =
r" [RFC 3307 (remove type ascription)][rfc-3307] for historical context."]
#[doc = r""]
#[doc =
r" [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md"]
#[doc =
r" [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md"]
#[doc =
r" [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md"]
pub static TRIVIAL_NUMERIC_CASTS: &crate::Lint =
&crate::Lint {
name: "TRIVIAL_NUMERIC_CASTS",
default_level: crate::Allow,
desc: "detects trivial casts of numeric types which could be removed",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1190/// The `trivial_numeric_casts` lint detects trivial numeric casts of types
1191 /// which could be removed.
1192 ///
1193 /// ### Example
1194 ///
1195 /// ```rust,compile_fail
1196 /// #![deny(trivial_numeric_casts)]
1197 /// let x = 42_i32 as i32;
1198 /// ```
1199 ///
1200 /// {{produces}}
1201 ///
1202 /// ### Explanation
1203 ///
1204 /// A trivial numeric cast is a cast of a numeric type to the same numeric
1205 /// type. This type of cast is usually unnecessary.
1206 ///
1207 /// This lint is "allow" by default because there are situations, such as
1208 /// with FFI interfaces or complex type aliases, where it triggers
1209 /// incorrectly, or in situations where it will be more difficult to
1210 /// clearly express the intent. It may be possible that this will become a
1211 /// warning in the future, possibly with an explicit syntax for coercions
1212 /// providing a convenient way to work around the current issues.
1213 /// See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and
1214 /// [RFC 3307 (remove type ascription)][rfc-3307] for historical context.
1215 ///
1216 /// [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
1217 /// [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md
1218 /// [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md
1219pub TRIVIAL_NUMERIC_CASTS,
1220 Allow,
1221"detects trivial casts of numeric types which could be removed"
1222}12231224#[doc =
r" The `exported_private_dependencies` lint detects private dependencies"]
#[doc = r" that are exposed in a public interface."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs-dependency)"]
#[doc = r" pub fn foo() -> Option<some_private_dependency::Thing> {"]
#[doc = r" None"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" warning: type `bar::Thing` from private dependency 'bar' in public interface"]
#[doc = r" --> src/lib.rs:3:1"]
#[doc = r" |"]
#[doc = r" 3 | pub fn foo() -> Option<bar::Thing> {"]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc = r" |"]
#[doc = r" = note: `#[warn(exported_private_dependencies)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r#" Dependencies can be marked as "private" to indicate that they are not"#]
#[doc =
r" exposed in the public interface of a crate. This can be used by Cargo"]
#[doc =
r" to independently resolve those dependencies because it can assume it"]
#[doc = r" does not need to unify them with other packages using that same"]
#[doc = r" dependency. This lint is an indication of a violation of that"]
#[doc = r" contract."]
#[doc = r""]
#[doc =
r" To fix this, avoid exposing the dependency in your public interface."]
#[doc = r" Or, switch the dependency to a public dependency."]
#[doc = r""]
#[doc =
r" Note that support for this is only available on the nightly channel."]
#[doc =
r" See [RFC 1977] for more details, as well as the [Cargo documentation]."]
#[doc = r""]
#[doc =
r" [RFC 1977]: https://github.com/rust-lang/rfcs/blob/master/text/1977-public-private-dependencies.md"]
#[doc =
r" [Cargo documentation]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#public-dependency"]
pub static EXPORTED_PRIVATE_DEPENDENCIES: &crate::Lint =
&crate::Lint {
name: "EXPORTED_PRIVATE_DEPENDENCIES",
default_level: crate::Warn,
desc: "public interface leaks type from a private dependency",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1225/// The `exported_private_dependencies` lint detects private dependencies
1226 /// that are exposed in a public interface.
1227 ///
1228 /// ### Example
1229 ///
1230 /// ```rust,ignore (needs-dependency)
1231 /// pub fn foo() -> Option<some_private_dependency::Thing> {
1232 /// None
1233 /// }
1234 /// ```
1235 ///
1236 /// This will produce:
1237 ///
1238 /// ```text
1239 /// warning: type `bar::Thing` from private dependency 'bar' in public interface
1240 /// --> src/lib.rs:3:1
1241 /// |
1242 /// 3 | pub fn foo() -> Option<bar::Thing> {
1243 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1244 /// |
1245 /// = note: `#[warn(exported_private_dependencies)]` on by default
1246 /// ```
1247 ///
1248 /// ### Explanation
1249 ///
1250 /// Dependencies can be marked as "private" to indicate that they are not
1251 /// exposed in the public interface of a crate. This can be used by Cargo
1252 /// to independently resolve those dependencies because it can assume it
1253 /// does not need to unify them with other packages using that same
1254 /// dependency. This lint is an indication of a violation of that
1255 /// contract.
1256 ///
1257 /// To fix this, avoid exposing the dependency in your public interface.
1258 /// Or, switch the dependency to a public dependency.
1259 ///
1260 /// Note that support for this is only available on the nightly channel.
1261 /// See [RFC 1977] for more details, as well as the [Cargo documentation].
1262 ///
1263 /// [RFC 1977]: https://github.com/rust-lang/rfcs/blob/master/text/1977-public-private-dependencies.md
1264 /// [Cargo documentation]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#public-dependency
1265pub EXPORTED_PRIVATE_DEPENDENCIES,
1266 Warn,
1267"public interface leaks type from a private dependency"
1268}12691270#[doc = r" The `pub_use_of_private_extern_crate` lint detects a specific"]
#[doc = r" situation of re-exporting a private `extern crate`."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" extern crate core;"]
#[doc = r" pub use core as reexported_core;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" A public `use` declaration should not be used to publically re-export a"]
#[doc =
r" private `extern crate`. `pub extern crate` should be used instead."]
#[doc = r""]
#[doc = r" This was historically allowed, but is not the intended behavior"]
#[doc =
r" according to the visibility rules. This is a [future-incompatible]"]
#[doc = r" lint to transition this to a hard error in the future. See [issue"]
#[doc = r" #127909] for more details."]
#[doc = r""]
#[doc = r" [issue #127909]: https://github.com/rust-lang/rust/issues/127909"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static PUB_USE_OF_PRIVATE_EXTERN_CRATE: &crate::Lint =
&crate::Lint {
name: "PUB_USE_OF_PRIVATE_EXTERN_CRATE",
default_level: crate::Deny,
desc: "detect public re-exports of private extern crates",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 127909,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1271/// The `pub_use_of_private_extern_crate` lint detects a specific
1272 /// situation of re-exporting a private `extern crate`.
1273 ///
1274 /// ### Example
1275 ///
1276 /// ```rust,compile_fail
1277 /// extern crate core;
1278 /// pub use core as reexported_core;
1279 /// ```
1280 ///
1281 /// {{produces}}
1282 ///
1283 /// ### Explanation
1284 ///
1285 /// A public `use` declaration should not be used to publically re-export a
1286 /// private `extern crate`. `pub extern crate` should be used instead.
1287 ///
1288 /// This was historically allowed, but is not the intended behavior
1289 /// according to the visibility rules. This is a [future-incompatible]
1290 /// lint to transition this to a hard error in the future. See [issue
1291 /// #127909] for more details.
1292 ///
1293 /// [issue #127909]: https://github.com/rust-lang/rust/issues/127909
1294 /// [future-incompatible]: ../index.md#future-incompatible-lints
1295pub PUB_USE_OF_PRIVATE_EXTERN_CRATE,
1296 Deny,
1297"detect public re-exports of private extern crates",
1298 @future_incompatible = FutureIncompatibleInfo {
1299 reason: fcw!(FutureReleaseError #127909),
1300 report_in_deps: true,
1301 };
1302}13031304#[doc =
r" The `invalid_type_param_default` lint detects type parameter defaults"]
#[doc = r" erroneously allowed in an invalid location."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" fn foo<T=i32>(t: T) {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Default type parameters were only intended to be allowed in certain"]
#[doc =
r" situations, but historically the compiler allowed them everywhere."]
#[doc = r" This is a [future-incompatible] lint to transition this to a hard"]
#[doc = r" error in the future. See [issue #36887] for more details."]
#[doc = r""]
#[doc = r" [issue #36887]: https://github.com/rust-lang/rust/issues/36887"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static INVALID_TYPE_PARAM_DEFAULT: &crate::Lint =
&crate::Lint {
name: "INVALID_TYPE_PARAM_DEFAULT",
default_level: crate::Deny,
desc: "type parameter default erroneously allowed in invalid location",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 36887,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1305/// The `invalid_type_param_default` lint detects type parameter defaults
1306 /// erroneously allowed in an invalid location.
1307 ///
1308 /// ### Example
1309 ///
1310 /// ```rust,compile_fail
1311 /// fn foo<T=i32>(t: T) {}
1312 /// ```
1313 ///
1314 /// {{produces}}
1315 ///
1316 /// ### Explanation
1317 ///
1318 /// Default type parameters were only intended to be allowed in certain
1319 /// situations, but historically the compiler allowed them everywhere.
1320 /// This is a [future-incompatible] lint to transition this to a hard
1321 /// error in the future. See [issue #36887] for more details.
1322 ///
1323 /// [issue #36887]: https://github.com/rust-lang/rust/issues/36887
1324 /// [future-incompatible]: ../index.md#future-incompatible-lints
1325pub INVALID_TYPE_PARAM_DEFAULT,
1326 Deny,
1327"type parameter default erroneously allowed in invalid location",
1328 @future_incompatible = FutureIncompatibleInfo {
1329 reason: fcw!(FutureReleaseError #36887),
1330 report_in_deps: true,
1331 };
1332}13331334#[doc = r" The `renamed_and_removed_lints` lint detects lints that have been"]
#[doc = r" renamed or removed."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![deny(raw_pointer_derive)]"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" To fix this, either remove the lint or use the new name. This can help"]
#[doc = r" avoid confusion about lints that are no longer valid, and help"]
#[doc = r" maintain consistency for renamed lints."]
pub static RENAMED_AND_REMOVED_LINTS: &crate::Lint =
&crate::Lint {
name: "RENAMED_AND_REMOVED_LINTS",
default_level: crate::Warn,
desc: "lints that have been renamed or removed",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1335/// The `renamed_and_removed_lints` lint detects lints that have been
1336 /// renamed or removed.
1337 ///
1338 /// ### Example
1339 ///
1340 /// ```rust
1341 /// #![deny(raw_pointer_derive)]
1342 /// ```
1343 ///
1344 /// {{produces}}
1345 ///
1346 /// ### Explanation
1347 ///
1348 /// To fix this, either remove the lint or use the new name. This can help
1349 /// avoid confusion about lints that are no longer valid, and help
1350 /// maintain consistency for renamed lints.
1351pub RENAMED_AND_REMOVED_LINTS,
1352 Warn,
1353"lints that have been renamed or removed"
1354}13551356#[doc =
r" The `const_item_mutation` lint detects attempts to mutate a `const`"]
#[doc = r" item."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" const FOO: [i32; 1] = [0];"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" FOO[0] = 1;"]
#[doc = r#" // This will print "[0]"."#]
#[doc = r#" println!("{:?}", FOO);"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Trying to directly mutate a `const` item is almost always a mistake."]
#[doc =
r" What is happening in the example above is that a temporary copy of the"]
#[doc =
r" `const` is mutated, but the original `const` is not. Each time you"]
#[doc =
r" refer to the `const` by name (such as `FOO` in the example above), a"]
#[doc = r" separate copy of the value is inlined at that location."]
#[doc = r""]
#[doc = r" This lint checks for writing directly to a field (`FOO.field ="]
#[doc = r" some_value`) or array entry (`FOO[0] = val`), or taking a mutable"]
#[doc = r" reference to the const item (`&mut FOO`), including through an"]
#[doc = r" autoderef (`FOO.some_mut_self_method()`)."]
#[doc = r""]
#[doc =
r" There are various alternatives depending on what you are trying to"]
#[doc = r" accomplish:"]
#[doc = r""]
#[doc = r" * First, always reconsider using mutable globals, as they can be"]
#[doc =
r" difficult to use correctly, and can make the code more difficult to"]
#[doc = r" use or understand."]
#[doc =
r" * If you are trying to perform a one-time initialization of a global:"]
#[doc =
r" * If the value can be computed at compile-time, consider using"]
#[doc = r" const-compatible values (see [Constant Evaluation])."]
#[doc =
r" * For more complex single-initialization cases, consider using"]
#[doc = r" [`std::sync::LazyLock`]."]
#[doc =
r" * If you truly need a mutable global, consider using a [`static`],"]
#[doc = r" which has a variety of options:"]
#[doc = r" * Simple data types can be directly defined and mutated with an"]
#[doc = r" [`atomic`] type."]
#[doc =
r" * More complex types can be placed in a synchronization primitive"]
#[doc =
r" like a [`Mutex`], which can be initialized with one of the options"]
#[doc = r" listed above."]
#[doc =
r" * A [mutable `static`] is a low-level primitive, requiring unsafe."]
#[doc = r" Typically This should be avoided in preference of something"]
#[doc = r" higher-level like one of the above."]
#[doc = r""]
#[doc =
r" [Constant Evaluation]: https://doc.rust-lang.org/reference/const_eval.html"]
#[doc =
r" [`static`]: https://doc.rust-lang.org/reference/items/static-items.html"]
#[doc =
r" [mutable `static`]: https://doc.rust-lang.org/reference/items/static-items.html#mutable-statics"]
#[doc =
r" [`std::sync::LazyLock`]: https://doc.rust-lang.org/stable/std/sync/struct.LazyLock.html"]
#[doc = r" [`atomic`]: https://doc.rust-lang.org/std/sync/atomic/index.html"]
#[doc = r" [`Mutex`]: https://doc.rust-lang.org/std/sync/struct.Mutex.html"]
pub static CONST_ITEM_MUTATION: &crate::Lint =
&crate::Lint {
name: "CONST_ITEM_MUTATION",
default_level: crate::Warn,
desc: "detects attempts to mutate a `const` item",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1357/// The `const_item_mutation` lint detects attempts to mutate a `const`
1358 /// item.
1359 ///
1360 /// ### Example
1361 ///
1362 /// ```rust
1363 /// const FOO: [i32; 1] = [0];
1364 ///
1365 /// fn main() {
1366 /// FOO[0] = 1;
1367 /// // This will print "[0]".
1368 /// println!("{:?}", FOO);
1369 /// }
1370 /// ```
1371 ///
1372 /// {{produces}}
1373 ///
1374 /// ### Explanation
1375 ///
1376 /// Trying to directly mutate a `const` item is almost always a mistake.
1377 /// What is happening in the example above is that a temporary copy of the
1378 /// `const` is mutated, but the original `const` is not. Each time you
1379 /// refer to the `const` by name (such as `FOO` in the example above), a
1380 /// separate copy of the value is inlined at that location.
1381 ///
1382 /// This lint checks for writing directly to a field (`FOO.field =
1383 /// some_value`) or array entry (`FOO[0] = val`), or taking a mutable
1384 /// reference to the const item (`&mut FOO`), including through an
1385 /// autoderef (`FOO.some_mut_self_method()`).
1386 ///
1387 /// There are various alternatives depending on what you are trying to
1388 /// accomplish:
1389 ///
1390 /// * First, always reconsider using mutable globals, as they can be
1391 /// difficult to use correctly, and can make the code more difficult to
1392 /// use or understand.
1393 /// * If you are trying to perform a one-time initialization of a global:
1394 /// * If the value can be computed at compile-time, consider using
1395 /// const-compatible values (see [Constant Evaluation]).
1396 /// * For more complex single-initialization cases, consider using
1397 /// [`std::sync::LazyLock`].
1398 /// * If you truly need a mutable global, consider using a [`static`],
1399 /// which has a variety of options:
1400 /// * Simple data types can be directly defined and mutated with an
1401 /// [`atomic`] type.
1402 /// * More complex types can be placed in a synchronization primitive
1403 /// like a [`Mutex`], which can be initialized with one of the options
1404 /// listed above.
1405 /// * A [mutable `static`] is a low-level primitive, requiring unsafe.
1406 /// Typically This should be avoided in preference of something
1407 /// higher-level like one of the above.
1408 ///
1409 /// [Constant Evaluation]: https://doc.rust-lang.org/reference/const_eval.html
1410 /// [`static`]: https://doc.rust-lang.org/reference/items/static-items.html
1411 /// [mutable `static`]: https://doc.rust-lang.org/reference/items/static-items.html#mutable-statics
1412 /// [`std::sync::LazyLock`]: https://doc.rust-lang.org/stable/std/sync/struct.LazyLock.html
1413 /// [`atomic`]: https://doc.rust-lang.org/std/sync/atomic/index.html
1414 /// [`Mutex`]: https://doc.rust-lang.org/std/sync/struct.Mutex.html
1415pub CONST_ITEM_MUTATION,
1416 Warn,
1417"detects attempts to mutate a `const` item",
1418}14191420#[doc = r" The `patterns_in_fns_without_body` lint detects `mut` identifier"]
#[doc = r" patterns as a parameter in functions without a body."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" trait Trait {"]
#[doc = r" fn foo(mut arg: u8);"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" To fix this, remove `mut` from the parameter in the trait definition;"]
#[doc =
r" it can be used in the implementation. That is, the following is OK:"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" trait Trait {"]
#[doc = r" fn foo(arg: u8); // Removed `mut` here"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl Trait for i32 {"]
#[doc = r" fn foo(mut arg: u8) { // `mut` here is OK"]
#[doc = r""]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" Trait definitions can define functions without a body to specify a"]
#[doc =
r" function that implementors must define. The parameter names in the"]
#[doc =
r" body-less functions are only allowed to be `_` or an [identifier] for"]
#[doc =
r" documentation purposes (only the type is relevant). Previous versions"]
#[doc =
r" of the compiler erroneously allowed [identifier patterns] with the"]
#[doc = r" `mut` keyword, but this was not intended to be allowed. This is a"]
#[doc =
r" [future-incompatible] lint to transition this to a hard error in the"]
#[doc = r" future. See [issue #35203] for more details."]
#[doc = r""]
#[doc =
r" [identifier]: https://doc.rust-lang.org/reference/identifiers.html"]
#[doc =
r" [identifier patterns]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns"]
#[doc = r" [issue #35203]: https://github.com/rust-lang/rust/issues/35203"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static PATTERNS_IN_FNS_WITHOUT_BODY: &crate::Lint =
&crate::Lint {
name: "PATTERNS_IN_FNS_WITHOUT_BODY",
default_level: crate::Deny,
desc: "patterns in functions without body were erroneously allowed",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 35203,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1421/// The `patterns_in_fns_without_body` lint detects `mut` identifier
1422 /// patterns as a parameter in functions without a body.
1423 ///
1424 /// ### Example
1425 ///
1426 /// ```rust,compile_fail
1427 /// trait Trait {
1428 /// fn foo(mut arg: u8);
1429 /// }
1430 /// ```
1431 ///
1432 /// {{produces}}
1433 ///
1434 /// ### Explanation
1435 ///
1436 /// To fix this, remove `mut` from the parameter in the trait definition;
1437 /// it can be used in the implementation. That is, the following is OK:
1438 ///
1439 /// ```rust
1440 /// trait Trait {
1441 /// fn foo(arg: u8); // Removed `mut` here
1442 /// }
1443 ///
1444 /// impl Trait for i32 {
1445 /// fn foo(mut arg: u8) { // `mut` here is OK
1446 ///
1447 /// }
1448 /// }
1449 /// ```
1450 ///
1451 /// Trait definitions can define functions without a body to specify a
1452 /// function that implementors must define. The parameter names in the
1453 /// body-less functions are only allowed to be `_` or an [identifier] for
1454 /// documentation purposes (only the type is relevant). Previous versions
1455 /// of the compiler erroneously allowed [identifier patterns] with the
1456 /// `mut` keyword, but this was not intended to be allowed. This is a
1457 /// [future-incompatible] lint to transition this to a hard error in the
1458 /// future. See [issue #35203] for more details.
1459 ///
1460 /// [identifier]: https://doc.rust-lang.org/reference/identifiers.html
1461 /// [identifier patterns]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
1462 /// [issue #35203]: https://github.com/rust-lang/rust/issues/35203
1463 /// [future-incompatible]: ../index.md#future-incompatible-lints
1464pub PATTERNS_IN_FNS_WITHOUT_BODY,
1465 Deny,
1466"patterns in functions without body were erroneously allowed",
1467 @future_incompatible = FutureIncompatibleInfo {
1468 reason: fcw!(FutureReleaseError #35203),
1469 };
1470}14711472#[doc = r" The `late_bound_lifetime_arguments` lint detects generic lifetime"]
#[doc = r" arguments in path segments with late bound lifetime parameters."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" struct S;"]
#[doc = r""]
#[doc = r" impl S {"]
#[doc = r" fn late(self, _: &u8, _: &u8) {}"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" S.late::<'static>(&0, &0);"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" It is not clear how to provide arguments for early-bound lifetime"]
#[doc =
r" parameters if they are intermixed with late-bound parameters in the"]
#[doc =
r" same list. For now, providing any explicit arguments will trigger this"]
#[doc =
r" lint if late-bound parameters are present, so in the future a solution"]
#[doc =
r" can be adopted without hitting backward compatibility issues. This is"]
#[doc =
r" a [future-incompatible] lint to transition this to a hard error in the"]
#[doc =
r" future. See [issue #42868] for more details, along with a description"]
#[doc = r" of the difference between early and late-bound parameters."]
#[doc = r""]
#[doc = r" [issue #42868]: https://github.com/rust-lang/rust/issues/42868"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static LATE_BOUND_LIFETIME_ARGUMENTS: &crate::Lint =
&crate::Lint {
name: "LATE_BOUND_LIFETIME_ARGUMENTS",
default_level: crate::Warn,
desc: "detects generic lifetime arguments in path segments with late bound lifetime parameters",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 42868,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1473/// The `late_bound_lifetime_arguments` lint detects generic lifetime
1474 /// arguments in path segments with late bound lifetime parameters.
1475 ///
1476 /// ### Example
1477 ///
1478 /// ```rust
1479 /// struct S;
1480 ///
1481 /// impl S {
1482 /// fn late(self, _: &u8, _: &u8) {}
1483 /// }
1484 ///
1485 /// fn main() {
1486 /// S.late::<'static>(&0, &0);
1487 /// }
1488 /// ```
1489 ///
1490 /// {{produces}}
1491 ///
1492 /// ### Explanation
1493 ///
1494 /// It is not clear how to provide arguments for early-bound lifetime
1495 /// parameters if they are intermixed with late-bound parameters in the
1496 /// same list. For now, providing any explicit arguments will trigger this
1497 /// lint if late-bound parameters are present, so in the future a solution
1498 /// can be adopted without hitting backward compatibility issues. This is
1499 /// a [future-incompatible] lint to transition this to a hard error in the
1500 /// future. See [issue #42868] for more details, along with a description
1501 /// of the difference between early and late-bound parameters.
1502 ///
1503 /// [issue #42868]: https://github.com/rust-lang/rust/issues/42868
1504 /// [future-incompatible]: ../index.md#future-incompatible-lints
1505pub LATE_BOUND_LIFETIME_ARGUMENTS,
1506 Warn,
1507"detects generic lifetime arguments in path segments with late bound lifetime parameters",
1508 @future_incompatible = FutureIncompatibleInfo {
1509 reason: fcw!(FutureReleaseError #42868),
1510 };
1511}15121513#[doc =
r" The `coherence_leak_check` lint detects conflicting implementations of"]
#[doc = r" a trait that are only distinguished by the old leak-check code."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" trait SomeTrait { }"]
#[doc = r" impl SomeTrait for for<'a> fn(&'a u8) { }"]
#[doc = r" impl<'a> SomeTrait for fn(&'a u8) { }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" In the past, the compiler would accept trait implementations for"]
#[doc =
r" identical functions that differed only in where the lifetime binder"]
#[doc =
r" appeared. Due to a change in the borrow checker implementation to fix"]
#[doc =
r" several bugs, this is no longer allowed. However, since this affects"]
#[doc =
r" existing code, this is a [future-incompatible] lint to transition this"]
#[doc = r" to a hard error in the future."]
#[doc = r""]
#[doc = r#" Code relying on this pattern should introduce "[newtypes]","#]
#[doc = r" like `struct Foo(for<'a> fn(&'a u8))`."]
#[doc = r""]
#[doc = r" See [issue #56105] for more details."]
#[doc = r""]
#[doc = r" [issue #56105]: https://github.com/rust-lang/rust/issues/56105"]
#[doc =
r" [newtypes]: https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static COHERENCE_LEAK_CHECK: &crate::Lint =
&crate::Lint {
name: "COHERENCE_LEAK_CHECK",
default_level: crate::Warn,
desc: "distinct impls distinguished only by the leak-check code",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::Custom("the behavior may change in a future release",
crate::ReleaseFcw { issue_number: 56105 }),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1514/// The `coherence_leak_check` lint detects conflicting implementations of
1515 /// a trait that are only distinguished by the old leak-check code.
1516 ///
1517 /// ### Example
1518 ///
1519 /// ```rust
1520 /// trait SomeTrait { }
1521 /// impl SomeTrait for for<'a> fn(&'a u8) { }
1522 /// impl<'a> SomeTrait for fn(&'a u8) { }
1523 /// ```
1524 ///
1525 /// {{produces}}
1526 ///
1527 /// ### Explanation
1528 ///
1529 /// In the past, the compiler would accept trait implementations for
1530 /// identical functions that differed only in where the lifetime binder
1531 /// appeared. Due to a change in the borrow checker implementation to fix
1532 /// several bugs, this is no longer allowed. However, since this affects
1533 /// existing code, this is a [future-incompatible] lint to transition this
1534 /// to a hard error in the future.
1535 ///
1536 /// Code relying on this pattern should introduce "[newtypes]",
1537 /// like `struct Foo(for<'a> fn(&'a u8))`.
1538 ///
1539 /// See [issue #56105] for more details.
1540 ///
1541 /// [issue #56105]: https://github.com/rust-lang/rust/issues/56105
1542 /// [newtypes]: https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction
1543 /// [future-incompatible]: ../index.md#future-incompatible-lints
1544pub COHERENCE_LEAK_CHECK,
1545 Warn,
1546"distinct impls distinguished only by the leak-check code",
1547 @future_incompatible = FutureIncompatibleInfo {
1548 reason: fcw!("the behavior may change in a future release" #56105),
1549 };
1550}15511552#[doc = r" The `deprecated` lint detects use of deprecated items."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #[deprecated]"]
#[doc = r" fn foo() {}"]
#[doc = r""]
#[doc = r" fn bar() {"]
#[doc = r" foo();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r#" Items may be marked "deprecated" with the [`deprecated` attribute] to"#]
#[doc =
r" indicate that they should no longer be used. Usually the attribute"]
#[doc = r" should include a note on what to use instead, or check the"]
#[doc = r" documentation."]
#[doc = r""]
#[doc =
r" [`deprecated` attribute]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute"]
pub static DEPRECATED: &crate::Lint =
&crate::Lint {
name: "DEPRECATED",
default_level: crate::Warn,
desc: "detects use of deprecated items",
is_externally_loaded: false,
report_in_external_macro: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1553/// The `deprecated` lint detects use of deprecated items.
1554 ///
1555 /// ### Example
1556 ///
1557 /// ```rust
1558 /// #[deprecated]
1559 /// fn foo() {}
1560 ///
1561 /// fn bar() {
1562 /// foo();
1563 /// }
1564 /// ```
1565 ///
1566 /// {{produces}}
1567 ///
1568 /// ### Explanation
1569 ///
1570 /// Items may be marked "deprecated" with the [`deprecated` attribute] to
1571 /// indicate that they should no longer be used. Usually the attribute
1572 /// should include a note on what to use instead, or check the
1573 /// documentation.
1574 ///
1575 /// [`deprecated` attribute]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute
1576pub DEPRECATED,
1577 Warn,
1578"detects use of deprecated items",
1579 report_in_external_macro
1580}15811582#[doc =
r" The `unused_unsafe` lint detects unnecessary use of an `unsafe` block."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" unsafe {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" If nothing within the block requires `unsafe`, then remove the"]
#[doc =
r" `unsafe` marker because it is not required and may cause confusion."]
pub static UNUSED_UNSAFE: &crate::Lint =
&crate::Lint {
name: "UNUSED_UNSAFE",
default_level: crate::Warn,
desc: "unnecessary use of an `unsafe` block",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1583/// The `unused_unsafe` lint detects unnecessary use of an `unsafe` block.
1584 ///
1585 /// ### Example
1586 ///
1587 /// ```rust
1588 /// unsafe {}
1589 /// ```
1590 ///
1591 /// {{produces}}
1592 ///
1593 /// ### Explanation
1594 ///
1595 /// If nothing within the block requires `unsafe`, then remove the
1596 /// `unsafe` marker because it is not required and may cause confusion.
1597pub UNUSED_UNSAFE,
1598 Warn,
1599"unnecessary use of an `unsafe` block"
1600}16011602#[doc =
r" The `unused_mut` lint detects mut variables which don't need to be"]
#[doc = r" mutable."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" let mut x = 5;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" The preferred style is to only mark variables as `mut` if it is"]
#[doc = r" required."]
pub static UNUSED_MUT: &crate::Lint =
&crate::Lint {
name: "UNUSED_MUT",
default_level: crate::Warn,
desc: "detect mut variables which don't need to be mutable",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1603/// The `unused_mut` lint detects mut variables which don't need to be
1604 /// mutable.
1605 ///
1606 /// ### Example
1607 ///
1608 /// ```rust
1609 /// let mut x = 5;
1610 /// ```
1611 ///
1612 /// {{produces}}
1613 ///
1614 /// ### Explanation
1615 ///
1616 /// The preferred style is to only mark variables as `mut` if it is
1617 /// required.
1618pub UNUSED_MUT,
1619 Warn,
1620"detect mut variables which don't need to be mutable"
1621}16221623#[doc = r" The `rust_2024_incompatible_pat` lint"]
#[doc =
r" detects patterns whose meaning will change in the Rust 2024 edition."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2021"]
#[doc = r" #![warn(rust_2024_incompatible_pat)]"]
#[doc = r""]
#[doc = r" if let Some(&a) = &Some(&0u8) {"]
#[doc = r" let _: u8 = a;"]
#[doc = r" }"]
#[doc = r" if let Some(mut _a) = &mut Some(0u8) {"]
#[doc = r" _a = 7u8;"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In Rust 2024 and above, the `mut` keyword does not reset the pattern binding mode,"]
#[doc =
r" and nor do `&` or `&mut` patterns. The lint will suggest code that"]
#[doc = r" has the same meaning in all editions."]
pub static RUST_2024_INCOMPATIBLE_PAT: &crate::Lint =
&crate::Lint {
name: "RUST_2024_INCOMPATIBLE_PAT",
default_level: crate::Allow,
desc: "detects patterns whose meaning will change in Rust 2024",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionSemanticsChange(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "match-ergonomics",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1624/// The `rust_2024_incompatible_pat` lint
1625 /// detects patterns whose meaning will change in the Rust 2024 edition.
1626 ///
1627 /// ### Example
1628 ///
1629 /// ```rust,edition2021
1630 /// #![warn(rust_2024_incompatible_pat)]
1631 ///
1632 /// if let Some(&a) = &Some(&0u8) {
1633 /// let _: u8 = a;
1634 /// }
1635 /// if let Some(mut _a) = &mut Some(0u8) {
1636 /// _a = 7u8;
1637 /// }
1638 /// ```
1639 ///
1640 /// {{produces}}
1641 ///
1642 /// ### Explanation
1643 ///
1644 /// In Rust 2024 and above, the `mut` keyword does not reset the pattern binding mode,
1645 /// and nor do `&` or `&mut` patterns. The lint will suggest code that
1646 /// has the same meaning in all editions.
1647pub RUST_2024_INCOMPATIBLE_PAT,
1648 Allow,
1649"detects patterns whose meaning will change in Rust 2024",
1650 @future_incompatible = FutureIncompatibleInfo {
1651 reason: fcw!(EditionSemanticsChange 2024 "match-ergonomics"),
1652 };
1653}16541655#[doc = r" The `unconditional_recursion` lint detects functions that cannot"]
#[doc = r" return without calling themselves."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" fn foo() {"]
#[doc = r" foo();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is usually a mistake to have a recursive call that does not have"]
#[doc =
r" some condition to cause it to terminate. If you really intend to have"]
#[doc = r" an infinite loop, using a `loop` expression is recommended."]
pub static UNCONDITIONAL_RECURSION: &crate::Lint =
&crate::Lint {
name: "UNCONDITIONAL_RECURSION",
default_level: crate::Warn,
desc: "functions that cannot return without calling themselves",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1656/// The `unconditional_recursion` lint detects functions that cannot
1657 /// return without calling themselves.
1658 ///
1659 /// ### Example
1660 ///
1661 /// ```rust
1662 /// fn foo() {
1663 /// foo();
1664 /// }
1665 /// ```
1666 ///
1667 /// {{produces}}
1668 ///
1669 /// ### Explanation
1670 ///
1671 /// It is usually a mistake to have a recursive call that does not have
1672 /// some condition to cause it to terminate. If you really intend to have
1673 /// an infinite loop, using a `loop` expression is recommended.
1674pub UNCONDITIONAL_RECURSION,
1675 Warn,
1676"functions that cannot return without calling themselves"
1677}16781679#[doc =
r" The `single_use_lifetimes` lint detects lifetimes that are only used"]
#[doc = r" once."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(single_use_lifetimes)]"]
#[doc = r""]
#[doc = r" fn foo<'a>(x: &'a u32) {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Specifying an explicit lifetime like `'a` in a function or `impl`"]
#[doc =
r" should only be used to link together two things. Otherwise, you should"]
#[doc =
r" just use `'_` to indicate that the lifetime is not linked to anything,"]
#[doc = r" or elide the lifetime altogether if possible."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because it was introduced at a time"#]
#[doc =
r" when `'_` and elided lifetimes were first being introduced, and this"]
#[doc =
r" lint would be too noisy. Also, there are some known false positives"]
#[doc =
r" that it produces. See [RFC 2115] for historical context, and [issue"]
#[doc = r" #44752] for more details."]
#[doc = r""]
#[doc =
r" [RFC 2115]: https://github.com/rust-lang/rfcs/blob/master/text/2115-argument-lifetimes.md"]
#[doc = r" [issue #44752]: https://github.com/rust-lang/rust/issues/44752"]
pub static SINGLE_USE_LIFETIMES: &crate::Lint =
&crate::Lint {
name: "SINGLE_USE_LIFETIMES",
default_level: crate::Allow,
desc: "detects lifetime parameters that are only used once",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1680/// The `single_use_lifetimes` lint detects lifetimes that are only used
1681 /// once.
1682 ///
1683 /// ### Example
1684 ///
1685 /// ```rust,compile_fail
1686 /// #![deny(single_use_lifetimes)]
1687 ///
1688 /// fn foo<'a>(x: &'a u32) {}
1689 /// ```
1690 ///
1691 /// {{produces}}
1692 ///
1693 /// ### Explanation
1694 ///
1695 /// Specifying an explicit lifetime like `'a` in a function or `impl`
1696 /// should only be used to link together two things. Otherwise, you should
1697 /// just use `'_` to indicate that the lifetime is not linked to anything,
1698 /// or elide the lifetime altogether if possible.
1699 ///
1700 /// This lint is "allow" by default because it was introduced at a time
1701 /// when `'_` and elided lifetimes were first being introduced, and this
1702 /// lint would be too noisy. Also, there are some known false positives
1703 /// that it produces. See [RFC 2115] for historical context, and [issue
1704 /// #44752] for more details.
1705 ///
1706 /// [RFC 2115]: https://github.com/rust-lang/rfcs/blob/master/text/2115-argument-lifetimes.md
1707 /// [issue #44752]: https://github.com/rust-lang/rust/issues/44752
1708pub SINGLE_USE_LIFETIMES,
1709 Allow,
1710"detects lifetime parameters that are only used once"
1711}17121713#[doc =
r" The `unused_lifetimes` lint detects lifetime parameters that are never"]
#[doc = r" used."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #[deny(unused_lifetimes)]"]
#[doc = r""]
#[doc = r" pub fn foo<'a>() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused lifetime parameters may signal a mistake or unfinished code."]
#[doc = r" Consider removing the parameter."]
pub static UNUSED_LIFETIMES: &crate::Lint =
&crate::Lint {
name: "UNUSED_LIFETIMES",
default_level: crate::Allow,
desc: "detects lifetime parameters that are never used",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1714/// The `unused_lifetimes` lint detects lifetime parameters that are never
1715 /// used.
1716 ///
1717 /// ### Example
1718 ///
1719 /// ```rust,compile_fail
1720 /// #[deny(unused_lifetimes)]
1721 ///
1722 /// pub fn foo<'a>() {}
1723 /// ```
1724 ///
1725 /// {{produces}}
1726 ///
1727 /// ### Explanation
1728 ///
1729 /// Unused lifetime parameters may signal a mistake or unfinished code.
1730 /// Consider removing the parameter.
1731pub UNUSED_LIFETIMES,
1732 Allow,
1733"detects lifetime parameters that are never used"
1734}17351736#[doc =
r" The `redundant_lifetimes` lint detects lifetime parameters that are"]
#[doc = r" redundant because they are equal to another named lifetime."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #[deny(redundant_lifetimes)]"]
#[doc = r""]
#[doc =
r" // `'a = 'static`, so all usages of `'a` can be replaced with `'static`"]
#[doc = r" pub fn bar<'a: 'static>() {}"]
#[doc = r""]
#[doc = r" // `'a = 'b`, so all usages of `'b` can be replaced with `'a`"]
#[doc = r" pub fn bar<'a: 'b, 'b: 'a>() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused lifetime parameters may signal a mistake or unfinished code."]
#[doc = r" Consider removing the parameter."]
pub static REDUNDANT_LIFETIMES: &crate::Lint =
&crate::Lint {
name: "REDUNDANT_LIFETIMES",
default_level: crate::Allow,
desc: "detects lifetime parameters that are redundant because they are equal to some other named lifetime",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1737/// The `redundant_lifetimes` lint detects lifetime parameters that are
1738 /// redundant because they are equal to another named lifetime.
1739 ///
1740 /// ### Example
1741 ///
1742 /// ```rust,compile_fail
1743 /// #[deny(redundant_lifetimes)]
1744 ///
1745 /// // `'a = 'static`, so all usages of `'a` can be replaced with `'static`
1746 /// pub fn bar<'a: 'static>() {}
1747 ///
1748 /// // `'a = 'b`, so all usages of `'b` can be replaced with `'a`
1749 /// pub fn bar<'a: 'b, 'b: 'a>() {}
1750 /// ```
1751 ///
1752 /// {{produces}}
1753 ///
1754 /// ### Explanation
1755 ///
1756 /// Unused lifetime parameters may signal a mistake or unfinished code.
1757 /// Consider removing the parameter.
1758pub REDUNDANT_LIFETIMES,
1759 Allow,
1760"detects lifetime parameters that are redundant because they are equal to some other named lifetime"
1761}17621763#[doc = r" The `tyvar_behind_raw_pointer` lint detects raw pointer to an"]
#[doc = r" inference variable."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2015"]
#[doc = r" // edition 2015"]
#[doc = r" let data = std::ptr::null();"]
#[doc = r" let _ = &data as *const *const ();"]
#[doc = r""]
#[doc = r" if data.is_null() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This kind of inference was previously allowed, but with the future"]
#[doc =
r" arrival of [arbitrary self types], this can introduce ambiguity. To"]
#[doc = r" resolve this, use an explicit type instead of relying on type"]
#[doc = r" inference."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a hard"]
#[doc =
r" error in the 2018 edition. See [issue #46906] for more details. This"]
#[doc = r#" is currently a hard-error on the 2018 edition, and is "warn" by"#]
#[doc = r" default in the 2015 edition."]
#[doc = r""]
#[doc =
r" [arbitrary self types]: https://github.com/rust-lang/rust/issues/44874"]
#[doc = r" [issue #46906]: https://github.com/rust-lang/rust/issues/46906"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static TYVAR_BEHIND_RAW_POINTER: &crate::Lint =
&crate::Lint {
name: "TYVAR_BEHIND_RAW_POINTER",
default_level: crate::Warn,
desc: "raw pointer to an inference variable",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2018,
page_slug: "tyvar-behind-raw-pointer",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1764/// The `tyvar_behind_raw_pointer` lint detects raw pointer to an
1765 /// inference variable.
1766 ///
1767 /// ### Example
1768 ///
1769 /// ```rust,edition2015
1770 /// // edition 2015
1771 /// let data = std::ptr::null();
1772 /// let _ = &data as *const *const ();
1773 ///
1774 /// if data.is_null() {}
1775 /// ```
1776 ///
1777 /// {{produces}}
1778 ///
1779 /// ### Explanation
1780 ///
1781 /// This kind of inference was previously allowed, but with the future
1782 /// arrival of [arbitrary self types], this can introduce ambiguity. To
1783 /// resolve this, use an explicit type instead of relying on type
1784 /// inference.
1785 ///
1786 /// This is a [future-incompatible] lint to transition this to a hard
1787 /// error in the 2018 edition. See [issue #46906] for more details. This
1788 /// is currently a hard-error on the 2018 edition, and is "warn" by
1789 /// default in the 2015 edition.
1790 ///
1791 /// [arbitrary self types]: https://github.com/rust-lang/rust/issues/44874
1792 /// [issue #46906]: https://github.com/rust-lang/rust/issues/46906
1793 /// [future-incompatible]: ../index.md#future-incompatible-lints
1794pub TYVAR_BEHIND_RAW_POINTER,
1795 Warn,
1796"raw pointer to an inference variable",
1797 @future_incompatible = FutureIncompatibleInfo {
1798 reason: fcw!(EditionError 2018 "tyvar-behind-raw-pointer"),
1799 };
1800}18011802#[doc = r" The `elided_lifetimes_in_paths` lint detects the use of hidden"]
#[doc = r" lifetime parameters."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(elided_lifetimes_in_paths)]"]
#[doc = r" #![deny(warnings)]"]
#[doc = r" struct Foo<'a> {"]
#[doc = r" x: &'a u32"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn foo(x: &Foo) {"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Elided lifetime parameters can make it difficult to see at a glance"]
#[doc = r" that borrowing is occurring. This lint ensures that lifetime"]
#[doc = r" parameters are always explicitly stated, even if it is the `'_`"]
#[doc = r" [placeholder lifetime]."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because it has some known issues, and"#]
#[doc = r" may require a significant transition for old code."]
#[doc = r""]
#[doc =
r" [placeholder lifetime]: https://doc.rust-lang.org/reference/lifetime-elision.html#lifetime-elision-in-functions"]
pub static ELIDED_LIFETIMES_IN_PATHS: &crate::Lint =
&crate::Lint {
name: "ELIDED_LIFETIMES_IN_PATHS",
default_level: crate::Allow,
desc: "hidden lifetime parameters in types are deprecated",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1803/// The `elided_lifetimes_in_paths` lint detects the use of hidden
1804 /// lifetime parameters.
1805 ///
1806 /// ### Example
1807 ///
1808 /// ```rust,compile_fail
1809 /// #![deny(elided_lifetimes_in_paths)]
1810 /// #![deny(warnings)]
1811 /// struct Foo<'a> {
1812 /// x: &'a u32
1813 /// }
1814 ///
1815 /// fn foo(x: &Foo) {
1816 /// }
1817 /// ```
1818 ///
1819 /// {{produces}}
1820 ///
1821 /// ### Explanation
1822 ///
1823 /// Elided lifetime parameters can make it difficult to see at a glance
1824 /// that borrowing is occurring. This lint ensures that lifetime
1825 /// parameters are always explicitly stated, even if it is the `'_`
1826 /// [placeholder lifetime].
1827 ///
1828 /// This lint is "allow" by default because it has some known issues, and
1829 /// may require a significant transition for old code.
1830 ///
1831 /// [placeholder lifetime]: https://doc.rust-lang.org/reference/lifetime-elision.html#lifetime-elision-in-functions
1832pub ELIDED_LIFETIMES_IN_PATHS,
1833 Allow,
1834"hidden lifetime parameters in types are deprecated"
1835}18361837#[doc =
r" The `bare_trait_objects` lint suggests using `dyn Trait` for trait"]
#[doc = r" objects."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2018"]
#[doc = r" trait Trait { }"]
#[doc = r""]
#[doc = r" fn takes_trait_object(_: Box<Trait>) {"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Without the `dyn` indicator, it can be ambiguous or confusing when"]
#[doc =
r" reading code as to whether or not you are looking at a trait object."]
#[doc =
r" The `dyn` keyword makes it explicit, and adds a symmetry to contrast"]
#[doc = r" with [`impl Trait`]."]
#[doc = r""]
#[doc =
r" [`impl Trait`]: https://doc.rust-lang.org/book/ch10-02-traits.html#traits-as-parameters"]
pub static BARE_TRAIT_OBJECTS: &crate::Lint =
&crate::Lint {
name: "BARE_TRAIT_OBJECTS",
default_level: crate::Warn,
desc: "suggest using `dyn Trait` for trait objects",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2021,
page_slug: "warnings-promoted-to-error",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1838/// The `bare_trait_objects` lint suggests using `dyn Trait` for trait
1839 /// objects.
1840 ///
1841 /// ### Example
1842 ///
1843 /// ```rust,edition2018
1844 /// trait Trait { }
1845 ///
1846 /// fn takes_trait_object(_: Box<Trait>) {
1847 /// }
1848 /// ```
1849 ///
1850 /// {{produces}}
1851 ///
1852 /// ### Explanation
1853 ///
1854 /// Without the `dyn` indicator, it can be ambiguous or confusing when
1855 /// reading code as to whether or not you are looking at a trait object.
1856 /// The `dyn` keyword makes it explicit, and adds a symmetry to contrast
1857 /// with [`impl Trait`].
1858 ///
1859 /// [`impl Trait`]: https://doc.rust-lang.org/book/ch10-02-traits.html#traits-as-parameters
1860pub BARE_TRAIT_OBJECTS,
1861 Warn,
1862"suggest using `dyn Trait` for trait objects",
1863 @future_incompatible = FutureIncompatibleInfo {
1864 reason: fcw!(EditionError 2021 "warnings-promoted-to-error"),
1865 };
1866}18671868#[doc = r" The `absolute_paths_not_starting_with_crate` lint detects fully"]
#[doc = r" qualified paths that start with a module name instead of `crate`,"]
#[doc = r" `self`, or an extern crate name"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2015,compile_fail"]
#[doc = r" #![deny(absolute_paths_not_starting_with_crate)]"]
#[doc = r""]
#[doc = r" mod foo {"]
#[doc = r" pub fn bar() {}"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" ::foo::bar();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Rust [editions] allow the language to evolve without breaking"]
#[doc =
r" backwards compatibility. This lint catches code that uses absolute"]
#[doc =
r" paths in the style of the 2015 edition. In the 2015 edition, absolute"]
#[doc =
r" paths (those starting with `::`) refer to either the crate root or an"]
#[doc =
r" external crate. In the 2018 edition it was changed so that they only"]
#[doc =
r" refer to external crates. The path prefix `crate::` should be used"]
#[doc = r" instead to reference items from the crate root."]
#[doc = r""]
#[doc = r" If you switch the compiler from the 2015 to 2018 edition without"]
#[doc =
r" updating the code, then it will fail to compile if the old style paths"]
#[doc = r" are used. You can manually change the paths to use the `crate::`"]
#[doc = r" prefix to transition to the 2018 edition."]
#[doc = r""]
#[doc =
r#" This lint solves the problem automatically. It is "allow" by default"#]
#[doc =
r" because the code is perfectly valid in the 2015 edition. The [`cargo"]
#[doc =
r#" fix`] tool with the `--edition` flag will switch this lint to "warn""#]
#[doc = r" and automatically apply the suggested fix from the compiler. This"]
#[doc =
r" provides a completely automated way to update old code to the 2018"]
#[doc = r" edition."]
#[doc = r""]
#[doc = r" [editions]: https://doc.rust-lang.org/edition-guide/"]
#[doc =
r" [`cargo fix`]: https://doc.rust-lang.org/cargo/commands/cargo-fix.html"]
pub static ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE: &crate::Lint =
&crate::Lint {
name: "ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE",
default_level: crate::Allow,
desc: "fully qualified paths that start with a module name \
instead of `crate`, `self`, or an extern crate name",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2018,
page_slug: "path-changes",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1869/// The `absolute_paths_not_starting_with_crate` lint detects fully
1870 /// qualified paths that start with a module name instead of `crate`,
1871 /// `self`, or an extern crate name
1872 ///
1873 /// ### Example
1874 ///
1875 /// ```rust,edition2015,compile_fail
1876 /// #![deny(absolute_paths_not_starting_with_crate)]
1877 ///
1878 /// mod foo {
1879 /// pub fn bar() {}
1880 /// }
1881 ///
1882 /// fn main() {
1883 /// ::foo::bar();
1884 /// }
1885 /// ```
1886 ///
1887 /// {{produces}}
1888 ///
1889 /// ### Explanation
1890 ///
1891 /// Rust [editions] allow the language to evolve without breaking
1892 /// backwards compatibility. This lint catches code that uses absolute
1893 /// paths in the style of the 2015 edition. In the 2015 edition, absolute
1894 /// paths (those starting with `::`) refer to either the crate root or an
1895 /// external crate. In the 2018 edition it was changed so that they only
1896 /// refer to external crates. The path prefix `crate::` should be used
1897 /// instead to reference items from the crate root.
1898 ///
1899 /// If you switch the compiler from the 2015 to 2018 edition without
1900 /// updating the code, then it will fail to compile if the old style paths
1901 /// are used. You can manually change the paths to use the `crate::`
1902 /// prefix to transition to the 2018 edition.
1903 ///
1904 /// This lint solves the problem automatically. It is "allow" by default
1905 /// because the code is perfectly valid in the 2015 edition. The [`cargo
1906 /// fix`] tool with the `--edition` flag will switch this lint to "warn"
1907 /// and automatically apply the suggested fix from the compiler. This
1908 /// provides a completely automated way to update old code to the 2018
1909 /// edition.
1910 ///
1911 /// [editions]: https://doc.rust-lang.org/edition-guide/
1912 /// [`cargo fix`]: https://doc.rust-lang.org/cargo/commands/cargo-fix.html
1913pub ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
1914 Allow,
1915"fully qualified paths that start with a module name \
1916 instead of `crate`, `self`, or an extern crate name",
1917 @future_incompatible = FutureIncompatibleInfo {
1918 reason: fcw!(EditionError 2018 "path-changes"),
1919 };
1920}19211922#[doc =
r" The `unstable_name_collisions` lint detects that you have used a name"]
#[doc = r" that the standard library plans to add in the future."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" trait MyIterator : Iterator {"]
#[doc =
r" // is_partitioned is an unstable method that already exists on the Iterator trait"]
#[doc = r" fn is_partitioned<P>(self, predicate: P) -> bool"]
#[doc = r" where"]
#[doc = r" Self: Sized,"]
#[doc = r" P: FnMut(Self::Item) -> bool,"]
#[doc = r" {true}"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl<T: ?Sized> MyIterator for T where T: Iterator { }"]
#[doc = r""]
#[doc = r" let x = vec![1, 2, 3];"]
#[doc = r" let _ = x.iter().is_partitioned(|_| true);"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" When new methods are added to traits in the standard library, they are"]
#[doc =
r#" usually added in an "unstable" form which is only available on the"#]
#[doc = r" [nightly channel] with a [`feature` attribute]. If there is any"]
#[doc =
r" preexisting code which extends a trait to have a method with the same"]
#[doc =
r" name, then the names will collide. In the future, when the method is"]
#[doc =
r" stabilized, this will cause an error due to the ambiguity. This lint"]
#[doc =
r" is an early-warning to let you know that there may be a collision in"]
#[doc = r" the future. This can be avoided by adding type annotations to"]
#[doc = r" disambiguate which trait method you intend to call, such as"]
#[doc =
r" `MyIterator::is_partitioned(my_iter, my_predicate)` or renaming or removing the method."]
#[doc = r""]
#[doc =
r" [nightly channel]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html"]
#[doc =
r" [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/"]
pub static UNSTABLE_NAME_COLLISIONS: &crate::Lint =
&crate::Lint {
name: "UNSTABLE_NAME_COLLISIONS",
default_level: crate::Warn,
desc: "detects name collision with an existing but unstable method",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::Custom("once this associated item is added to the standard library, \
the ambiguity may cause an error or change in behavior!",
crate::ReleaseFcw { issue_number: 48919 }),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1923/// The `unstable_name_collisions` lint detects that you have used a name
1924 /// that the standard library plans to add in the future.
1925 ///
1926 /// ### Example
1927 ///
1928 /// ```rust
1929 /// trait MyIterator : Iterator {
1930 /// // is_partitioned is an unstable method that already exists on the Iterator trait
1931 /// fn is_partitioned<P>(self, predicate: P) -> bool
1932 /// where
1933 /// Self: Sized,
1934 /// P: FnMut(Self::Item) -> bool,
1935 /// {true}
1936 /// }
1937 ///
1938 /// impl<T: ?Sized> MyIterator for T where T: Iterator { }
1939 ///
1940 /// let x = vec![1, 2, 3];
1941 /// let _ = x.iter().is_partitioned(|_| true);
1942 /// ```
1943 ///
1944 /// {{produces}}
1945 ///
1946 /// ### Explanation
1947 ///
1948 /// When new methods are added to traits in the standard library, they are
1949 /// usually added in an "unstable" form which is only available on the
1950 /// [nightly channel] with a [`feature` attribute]. If there is any
1951 /// preexisting code which extends a trait to have a method with the same
1952 /// name, then the names will collide. In the future, when the method is
1953 /// stabilized, this will cause an error due to the ambiguity. This lint
1954 /// is an early-warning to let you know that there may be a collision in
1955 /// the future. This can be avoided by adding type annotations to
1956 /// disambiguate which trait method you intend to call, such as
1957 /// `MyIterator::is_partitioned(my_iter, my_predicate)` or renaming or removing the method.
1958 ///
1959 /// [nightly channel]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
1960 /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
1961pub UNSTABLE_NAME_COLLISIONS,
1962 Warn,
1963"detects name collision with an existing but unstable method",
1964 @future_incompatible = FutureIncompatibleInfo {
1965 reason: fcw!(
1966"once this associated item is added to the standard library, \
1967 the ambiguity may cause an error or change in behavior!"
1968#48919
1969),
1970// Note: this item represents future incompatibility of all unstable functions in the
1971 // standard library, and thus should never be removed or changed to an error.
1972};
1973}19741975#[doc =
r" The `irrefutable_let_patterns` lint detects [irrefutable patterns]"]
#[doc = r" in [`if let`]s, [`while let`]s, and `if let` guards."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" if let _ = 123 {"]
#[doc = r#" println!("always runs!");"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" There usually isn't a reason to have an irrefutable pattern in an"]
#[doc =
r" `if let` or `while let` statement, because the pattern will always match"]
#[doc =
r" successfully. A [`let`] or [`loop`] statement will suffice. However,"]
#[doc =
r" when generating code with a macro, forbidding irrefutable patterns"]
#[doc = r" would require awkward workarounds in situations where the macro"]
#[doc = r" doesn't know if the pattern is refutable or not. This lint allows"]
#[doc =
r" macros to accept this form, while alerting for a possibly incorrect"]
#[doc = r" use in normal code."]
#[doc = r""]
#[doc = r" See [RFC 2086] for more details."]
#[doc = r""]
#[doc =
r" [irrefutable patterns]: https://doc.rust-lang.org/reference/patterns.html#refutability"]
#[doc =
r" [`if let`]: https://doc.rust-lang.org/reference/expressions/if-expr.html#if-let-expressions"]
#[doc =
r" [`while let`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#predicate-pattern-loops"]
#[doc =
r" [`let`]: https://doc.rust-lang.org/reference/statements.html#let-statements"]
#[doc =
r" [`loop`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#infinite-loops"]
#[doc =
r" [RFC 2086]: https://github.com/rust-lang/rfcs/blob/master/text/2086-allow-if-let-irrefutables.md"]
pub static IRREFUTABLE_LET_PATTERNS: &crate::Lint =
&crate::Lint {
name: "IRREFUTABLE_LET_PATTERNS",
default_level: crate::Warn,
desc: "detects irrefutable patterns in `if let` and `while let` statements",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1976/// The `irrefutable_let_patterns` lint detects [irrefutable patterns]
1977 /// in [`if let`]s, [`while let`]s, and `if let` guards.
1978 ///
1979 /// ### Example
1980 ///
1981 /// ```rust
1982 /// if let _ = 123 {
1983 /// println!("always runs!");
1984 /// }
1985 /// ```
1986 ///
1987 /// {{produces}}
1988 ///
1989 /// ### Explanation
1990 ///
1991 /// There usually isn't a reason to have an irrefutable pattern in an
1992 /// `if let` or `while let` statement, because the pattern will always match
1993 /// successfully. A [`let`] or [`loop`] statement will suffice. However,
1994 /// when generating code with a macro, forbidding irrefutable patterns
1995 /// would require awkward workarounds in situations where the macro
1996 /// doesn't know if the pattern is refutable or not. This lint allows
1997 /// macros to accept this form, while alerting for a possibly incorrect
1998 /// use in normal code.
1999 ///
2000 /// See [RFC 2086] for more details.
2001 ///
2002 /// [irrefutable patterns]: https://doc.rust-lang.org/reference/patterns.html#refutability
2003 /// [`if let`]: https://doc.rust-lang.org/reference/expressions/if-expr.html#if-let-expressions
2004 /// [`while let`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#predicate-pattern-loops
2005 /// [`let`]: https://doc.rust-lang.org/reference/statements.html#let-statements
2006 /// [`loop`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#infinite-loops
2007 /// [RFC 2086]: https://github.com/rust-lang/rfcs/blob/master/text/2086-allow-if-let-irrefutables.md
2008pub IRREFUTABLE_LET_PATTERNS,
2009 Warn,
2010"detects irrefutable patterns in `if let` and `while let` statements"
2011}20122013#[doc = r" The `unused_labels` lint detects [labels] that are never used."]
#[doc = r""]
#[doc =
r" [labels]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#loop-labels"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,no_run"]
#[doc = r" 'unused_label: loop {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unused labels may signal a mistake or unfinished code. To silence the"]
#[doc =
r" warning for the individual label, prefix it with an underscore such as"]
#[doc = r" `'_my_label:`."]
pub static UNUSED_LABELS: &crate::Lint =
&crate::Lint {
name: "UNUSED_LABELS",
default_level: crate::Warn,
desc: "detects labels that are never used",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2014/// The `unused_labels` lint detects [labels] that are never used.
2015 ///
2016 /// [labels]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#loop-labels
2017 ///
2018 /// ### Example
2019 ///
2020 /// ```rust,no_run
2021 /// 'unused_label: loop {}
2022 /// ```
2023 ///
2024 /// {{produces}}
2025 ///
2026 /// ### Explanation
2027 ///
2028 /// Unused labels may signal a mistake or unfinished code. To silence the
2029 /// warning for the individual label, prefix it with an underscore such as
2030 /// `'_my_label:`.
2031pub UNUSED_LABELS,
2032 Warn,
2033"detects labels that are never used"
2034}20352036#[doc =
r" The `proc_macro_derive_resolution_fallback` lint detects proc macro"]
#[doc = r" derives using inaccessible names from parent modules."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (proc-macro)"]
#[doc = r" // foo.rs"]
#[doc = r#" #![crate_type = "proc-macro"]"#]
#[doc = r""]
#[doc = r" extern crate proc_macro;"]
#[doc = r""]
#[doc = r" use proc_macro::*;"]
#[doc = r""]
#[doc = r" #[proc_macro_derive(Foo)]"]
#[doc = r" pub fn foo1(a: TokenStream) -> TokenStream {"]
#[doc = r" drop(a);"]
#[doc =
r#" "mod __bar { static mut BAR: Option<Something> = None; }".parse().unwrap()"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs-dependency)"]
#[doc = r" // bar.rs"]
#[doc = r" #[macro_use]"]
#[doc = r" extern crate foo;"]
#[doc = r""]
#[doc = r" struct Something;"]
#[doc = r""]
#[doc = r" #[derive(Foo)]"]
#[doc = r" struct Another;"]
#[doc = r""]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: cannot find type `Something` in this scope"]
#[doc = r" --> src/main.rs:8:10"]
#[doc = r" |"]
#[doc = r" 8 | #[derive(Foo)]"]
#[doc =
r" | ^^^ names from parent modules are not accessible without an explicit import"]
#[doc = r" |"]
#[doc =
r" = note: `#[warn(proc_macro_derive_resolution_fallback)]` on by default"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!"]
#[doc =
r" = note: for more information, see issue #50504 <https://github.com/rust-lang/rust/issues/50504>"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" If a proc-macro generates a module, the compiler unintentionally"]
#[doc = r" allowed items in that module to refer to items in the crate root"]
#[doc = r" without importing them. This is a [future-incompatible] lint to"]
#[doc =
r" transition this to a hard error in the future. See [issue #50504] for"]
#[doc = r" more details."]
#[doc = r""]
#[doc = r" [issue #50504]: https://github.com/rust-lang/rust/issues/50504"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static PROC_MACRO_DERIVE_RESOLUTION_FALLBACK: &crate::Lint =
&crate::Lint {
name: "PROC_MACRO_DERIVE_RESOLUTION_FALLBACK",
default_level: crate::Deny,
desc: "detects proc macro derives using inaccessible names from parent modules",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 83583,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2037/// The `proc_macro_derive_resolution_fallback` lint detects proc macro
2038 /// derives using inaccessible names from parent modules.
2039 ///
2040 /// ### Example
2041 ///
2042 /// ```rust,ignore (proc-macro)
2043 /// // foo.rs
2044 /// #![crate_type = "proc-macro"]
2045 ///
2046 /// extern crate proc_macro;
2047 ///
2048 /// use proc_macro::*;
2049 ///
2050 /// #[proc_macro_derive(Foo)]
2051 /// pub fn foo1(a: TokenStream) -> TokenStream {
2052 /// drop(a);
2053 /// "mod __bar { static mut BAR: Option<Something> = None; }".parse().unwrap()
2054 /// }
2055 /// ```
2056 ///
2057 /// ```rust,ignore (needs-dependency)
2058 /// // bar.rs
2059 /// #[macro_use]
2060 /// extern crate foo;
2061 ///
2062 /// struct Something;
2063 ///
2064 /// #[derive(Foo)]
2065 /// struct Another;
2066 ///
2067 /// fn main() {}
2068 /// ```
2069 ///
2070 /// This will produce:
2071 ///
2072 /// ```text
2073 /// warning: cannot find type `Something` in this scope
2074 /// --> src/main.rs:8:10
2075 /// |
2076 /// 8 | #[derive(Foo)]
2077 /// | ^^^ names from parent modules are not accessible without an explicit import
2078 /// |
2079 /// = note: `#[warn(proc_macro_derive_resolution_fallback)]` on by default
2080 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
2081 /// = note: for more information, see issue #50504 <https://github.com/rust-lang/rust/issues/50504>
2082 /// ```
2083 ///
2084 /// ### Explanation
2085 ///
2086 /// If a proc-macro generates a module, the compiler unintentionally
2087 /// allowed items in that module to refer to items in the crate root
2088 /// without importing them. This is a [future-incompatible] lint to
2089 /// transition this to a hard error in the future. See [issue #50504] for
2090 /// more details.
2091 ///
2092 /// [issue #50504]: https://github.com/rust-lang/rust/issues/50504
2093 /// [future-incompatible]: ../index.md#future-incompatible-lints
2094pub PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
2095 Deny,
2096"detects proc macro derives using inaccessible names from parent modules",
2097 @future_incompatible = FutureIncompatibleInfo {
2098 reason: fcw!(FutureReleaseError #83583),
2099 report_in_deps: true,
2100 };
2101}21022103#[doc =
r" The `macro_use_extern_crate` lint detects the use of the [`macro_use` attribute]."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs extern crate)"]
#[doc = r" #![deny(macro_use_extern_crate)]"]
#[doc = r""]
#[doc = r" #[macro_use]"]
#[doc = r" extern crate serde_json;"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" let _ = json!{{}};"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" error: applying the `#[macro_use]` attribute to an `extern crate` item is deprecated"]
#[doc = r" --> src/main.rs:3:1"]
#[doc = r" |"]
#[doc = r" 3 | #[macro_use]"]
#[doc = r" | ^^^^^^^^^^^^"]
#[doc = r" |"]
#[doc =
r" = help: remove it and import macros at use sites with a `use` item instead"]
#[doc = r" note: the lint level is defined here"]
#[doc = r" --> src/main.rs:1:9"]
#[doc = r" |"]
#[doc = r" 1 | #![deny(macro_use_extern_crate)]"]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" The [`macro_use` attribute] on an [`extern crate`] item causes"]
#[doc =
r" macros in that external crate to be brought into the prelude of the"]
#[doc =
r" crate, making the macros in scope everywhere. As part of the efforts"]
#[doc =
r" to simplify handling of dependencies in the [2018 edition], the use of"]
#[doc =
r" `extern crate` is being phased out. To bring macros from extern crates"]
#[doc = r" into scope, it is recommended to use a [`use` import]."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because this is a stylistic choice"#]
#[doc =
r" that has not been settled, see [issue #52043] for more information."]
#[doc = r""]
#[doc =
r" [`macro_use` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#the-macro_use-attribute"]
#[doc =
r" [`use` import]: https://doc.rust-lang.org/reference/items/use-declarations.html"]
#[doc = r" [issue #52043]: https://github.com/rust-lang/rust/issues/52043"]
pub static MACRO_USE_EXTERN_CRATE: &crate::Lint =
&crate::Lint {
name: "MACRO_USE_EXTERN_CRATE",
default_level: crate::Allow,
desc: "the `#[macro_use]` attribute is now deprecated in favor of using macros \
via the module system",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2104/// The `macro_use_extern_crate` lint detects the use of the [`macro_use` attribute].
2105 ///
2106 /// ### Example
2107 ///
2108 /// ```rust,ignore (needs extern crate)
2109 /// #![deny(macro_use_extern_crate)]
2110 ///
2111 /// #[macro_use]
2112 /// extern crate serde_json;
2113 ///
2114 /// fn main() {
2115 /// let _ = json!{{}};
2116 /// }
2117 /// ```
2118 ///
2119 /// This will produce:
2120 ///
2121 /// ```text
2122 /// error: applying the `#[macro_use]` attribute to an `extern crate` item is deprecated
2123 /// --> src/main.rs:3:1
2124 /// |
2125 /// 3 | #[macro_use]
2126 /// | ^^^^^^^^^^^^
2127 /// |
2128 /// = help: remove it and import macros at use sites with a `use` item instead
2129 /// note: the lint level is defined here
2130 /// --> src/main.rs:1:9
2131 /// |
2132 /// 1 | #![deny(macro_use_extern_crate)]
2133 /// | ^^^^^^^^^^^^^^^^^^^^^^
2134 /// ```
2135 ///
2136 /// ### Explanation
2137 ///
2138 /// The [`macro_use` attribute] on an [`extern crate`] item causes
2139 /// macros in that external crate to be brought into the prelude of the
2140 /// crate, making the macros in scope everywhere. As part of the efforts
2141 /// to simplify handling of dependencies in the [2018 edition], the use of
2142 /// `extern crate` is being phased out. To bring macros from extern crates
2143 /// into scope, it is recommended to use a [`use` import].
2144 ///
2145 /// This lint is "allow" by default because this is a stylistic choice
2146 /// that has not been settled, see [issue #52043] for more information.
2147 ///
2148 /// [`macro_use` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#the-macro_use-attribute
2149 /// [`use` import]: https://doc.rust-lang.org/reference/items/use-declarations.html
2150 /// [issue #52043]: https://github.com/rust-lang/rust/issues/52043
2151pub MACRO_USE_EXTERN_CRATE,
2152 Allow,
2153"the `#[macro_use]` attribute is now deprecated in favor of using macros \
2154 via the module system"
2155}21562157#[doc =
r" The `macro_expanded_macro_exports_accessed_by_absolute_paths` lint"]
#[doc =
r" detects macro-expanded [`macro_export`] macros from the current crate"]
#[doc = r" that cannot be referred to by absolute paths."]
#[doc = r""]
#[doc =
r" [`macro_export`]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" macro_rules! define_exported {"]
#[doc = r" () => {"]
#[doc = r" #[macro_export]"]
#[doc = r" macro_rules! exported {"]
#[doc = r" () => {};"]
#[doc = r" }"]
#[doc = r" };"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" define_exported!();"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" crate::exported!();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" The intent is that all macros marked with the `#[macro_export]`"]
#[doc =
r" attribute are made available in the root of the crate. However, when a"]
#[doc =
r" `macro_rules!` definition is generated by another macro, the macro"]
#[doc = r" expansion is unable to uphold this rule. This is a"]
#[doc =
r" [future-incompatible] lint to transition this to a hard error in the"]
#[doc = r" future. See [issue #53495] for more details."]
#[doc = r""]
#[doc = r" [issue #53495]: https://github.com/rust-lang/rust/issues/53495"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS:
&crate::Lint =
&crate::Lint {
name: "MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS",
default_level: crate::Deny,
desc: "macro-expanded `macro_export` macros from the current crate \
cannot be referred to by absolute paths",
is_externally_loaded: false,
crate_level_only: true,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 52234,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2158/// The `macro_expanded_macro_exports_accessed_by_absolute_paths` lint
2159 /// detects macro-expanded [`macro_export`] macros from the current crate
2160 /// that cannot be referred to by absolute paths.
2161 ///
2162 /// [`macro_export`]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
2163 ///
2164 /// ### Example
2165 ///
2166 /// ```rust,compile_fail
2167 /// macro_rules! define_exported {
2168 /// () => {
2169 /// #[macro_export]
2170 /// macro_rules! exported {
2171 /// () => {};
2172 /// }
2173 /// };
2174 /// }
2175 ///
2176 /// define_exported!();
2177 ///
2178 /// fn main() {
2179 /// crate::exported!();
2180 /// }
2181 /// ```
2182 ///
2183 /// {{produces}}
2184 ///
2185 /// ### Explanation
2186 ///
2187 /// The intent is that all macros marked with the `#[macro_export]`
2188 /// attribute are made available in the root of the crate. However, when a
2189 /// `macro_rules!` definition is generated by another macro, the macro
2190 /// expansion is unable to uphold this rule. This is a
2191 /// [future-incompatible] lint to transition this to a hard error in the
2192 /// future. See [issue #53495] for more details.
2193 ///
2194 /// [issue #53495]: https://github.com/rust-lang/rust/issues/53495
2195 /// [future-incompatible]: ../index.md#future-incompatible-lints
2196pub MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2197 Deny,
2198"macro-expanded `macro_export` macros from the current crate \
2199 cannot be referred to by absolute paths",
2200 @future_incompatible = FutureIncompatibleInfo {
2201 reason: fcw!(FutureReleaseError #52234),
2202 report_in_deps: true,
2203 };
2204 crate_level_only
2205}22062207#[doc = r" The `explicit_outlives_requirements` lint detects unnecessary"]
#[doc = r" lifetime bounds that can be inferred."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" # #![allow(unused)]"]
#[doc = r" #![deny(explicit_outlives_requirements)]"]
#[doc = r" #![deny(warnings)]"]
#[doc = r""]
#[doc = r" struct SharedRef<'a, T>"]
#[doc = r" where"]
#[doc = r" T: 'a,"]
#[doc = r" {"]
#[doc = r" data: &'a T,"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" If a `struct` contains a reference, such as `&'a T`, the compiler"]
#[doc = r" requires that `T` outlives the lifetime `'a`. This historically"]
#[doc = r" required writing an explicit lifetime bound to indicate this"]
#[doc =
r" requirement. However, this can be overly explicit, causing clutter and"]
#[doc = r" unnecessary complexity. The language was changed to automatically"]
#[doc =
r" infer the bound if it is not specified. Specifically, if the struct"]
#[doc =
r" contains a reference, directly or indirectly, to `T` with lifetime"]
#[doc = r" `'x`, then it will infer that `T: 'x` is a requirement."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default because it can be noisy for existing"#]
#[doc =
r" code that already had these requirements. This is a stylistic choice,"]
#[doc =
r" as it is still valid to explicitly state the bound. It also has some"]
#[doc = r" false positives that can cause confusion."]
#[doc = r""]
#[doc = r" See [RFC 2093] for more details."]
#[doc = r""]
#[doc =
r" [RFC 2093]: https://github.com/rust-lang/rfcs/blob/master/text/2093-infer-outlives.md"]
pub static EXPLICIT_OUTLIVES_REQUIREMENTS: &crate::Lint =
&crate::Lint {
name: "EXPLICIT_OUTLIVES_REQUIREMENTS",
default_level: crate::Allow,
desc: "outlives requirements can be inferred",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2208/// The `explicit_outlives_requirements` lint detects unnecessary
2209 /// lifetime bounds that can be inferred.
2210 ///
2211 /// ### Example
2212 ///
2213 /// ```rust,compile_fail
2214 /// # #![allow(unused)]
2215 /// #![deny(explicit_outlives_requirements)]
2216 /// #![deny(warnings)]
2217 ///
2218 /// struct SharedRef<'a, T>
2219 /// where
2220 /// T: 'a,
2221 /// {
2222 /// data: &'a T,
2223 /// }
2224 /// ```
2225 ///
2226 /// {{produces}}
2227 ///
2228 /// ### Explanation
2229 ///
2230 /// If a `struct` contains a reference, such as `&'a T`, the compiler
2231 /// requires that `T` outlives the lifetime `'a`. This historically
2232 /// required writing an explicit lifetime bound to indicate this
2233 /// requirement. However, this can be overly explicit, causing clutter and
2234 /// unnecessary complexity. The language was changed to automatically
2235 /// infer the bound if it is not specified. Specifically, if the struct
2236 /// contains a reference, directly or indirectly, to `T` with lifetime
2237 /// `'x`, then it will infer that `T: 'x` is a requirement.
2238 ///
2239 /// This lint is "allow" by default because it can be noisy for existing
2240 /// code that already had these requirements. This is a stylistic choice,
2241 /// as it is still valid to explicitly state the bound. It also has some
2242 /// false positives that can cause confusion.
2243 ///
2244 /// See [RFC 2093] for more details.
2245 ///
2246 /// [RFC 2093]: https://github.com/rust-lang/rfcs/blob/master/text/2093-infer-outlives.md
2247pub EXPLICIT_OUTLIVES_REQUIREMENTS,
2248 Allow,
2249"outlives requirements can be inferred"
2250}22512252#[doc =
r" The `deprecated_in_future` lint is internal to rustc and should not be"]
#[doc = r" used by user code."]
#[doc = r""]
#[doc =
r" This lint is only enabled in the standard library. It works with the"]
#[doc =
r" use of `#[deprecated]` with a `since` field of a version in the future."]
#[doc =
r" This allows something to be marked as deprecated in a future version,"]
#[doc =
r" and then this lint will ensure that the item is no longer used in the"]
#[doc =
r" standard library. See the [stability documentation] for more details."]
#[doc = r""]
#[doc =
r" [stability documentation]: https://rustc-dev-guide.rust-lang.org/stability.html#deprecated"]
pub static DEPRECATED_IN_FUTURE: &crate::Lint =
&crate::Lint {
name: "DEPRECATED_IN_FUTURE",
default_level: crate::Allow,
desc: "detects use of items that will be deprecated in a future version",
is_externally_loaded: false,
report_in_external_macro: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2253/// The `deprecated_in_future` lint is internal to rustc and should not be
2254 /// used by user code.
2255 ///
2256 /// This lint is only enabled in the standard library. It works with the
2257 /// use of `#[deprecated]` with a `since` field of a version in the future.
2258 /// This allows something to be marked as deprecated in a future version,
2259 /// and then this lint will ensure that the item is no longer used in the
2260 /// standard library. See the [stability documentation] for more details.
2261 ///
2262 /// [stability documentation]: https://rustc-dev-guide.rust-lang.org/stability.html#deprecated
2263pub DEPRECATED_IN_FUTURE,
2264 Allow,
2265"detects use of items that will be deprecated in a future version",
2266 report_in_external_macro
2267}22682269#[doc = r" The `ambiguous_associated_items` lint detects ambiguity between"]
#[doc = r" [associated items] and [enum variants]."]
#[doc = r""]
#[doc =
r" [associated items]: https://doc.rust-lang.org/reference/items/associated-items.html"]
#[doc =
r" [enum variants]: https://doc.rust-lang.org/reference/items/enumerations.html"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" enum E {"]
#[doc = r" V"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" trait Tr {"]
#[doc = r" type V;"]
#[doc = r" fn foo() -> Self::V;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl Tr for E {"]
#[doc = r" type V = u8;"]
#[doc =
r" // `Self::V` is ambiguous because it may refer to the associated type or"]
#[doc = r" // the enum variant."]
#[doc = r" fn foo() -> Self::V { 0 }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Previous versions of Rust did not allow accessing enum variants"]
#[doc =
r" through [type aliases]. When this ability was added (see [RFC 2338]), this"]
#[doc = r" introduced some situations where it can be ambiguous what a type"]
#[doc = r" was referring to."]
#[doc = r""]
#[doc =
r" To fix this ambiguity, you should use a [qualified path] to explicitly"]
#[doc = r" state which type to use. For example, in the above example the"]
#[doc = r" function can be written as `fn f() -> <Self as Tr>::V { 0 }` to"]
#[doc = r" specifically refer to the associated type."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a hard"]
#[doc = r" error in the future. See [issue #57644] for more details."]
#[doc = r""]
#[doc = r" [issue #57644]: https://github.com/rust-lang/rust/issues/57644"]
#[doc =
r" [type aliases]: https://doc.rust-lang.org/reference/items/type-aliases.html#type-aliases"]
#[doc =
r" [RFC 2338]: https://github.com/rust-lang/rfcs/blob/master/text/2338-type-alias-enum-variants.md"]
#[doc =
r" [qualified path]: https://doc.rust-lang.org/reference/paths.html#qualified-paths"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static AMBIGUOUS_ASSOCIATED_ITEMS: &crate::Lint =
&crate::Lint {
name: "AMBIGUOUS_ASSOCIATED_ITEMS",
default_level: crate::Deny,
desc: "ambiguous associated items",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 57644,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2270/// The `ambiguous_associated_items` lint detects ambiguity between
2271 /// [associated items] and [enum variants].
2272 ///
2273 /// [associated items]: https://doc.rust-lang.org/reference/items/associated-items.html
2274 /// [enum variants]: https://doc.rust-lang.org/reference/items/enumerations.html
2275 ///
2276 /// ### Example
2277 ///
2278 /// ```rust,compile_fail
2279 /// enum E {
2280 /// V
2281 /// }
2282 ///
2283 /// trait Tr {
2284 /// type V;
2285 /// fn foo() -> Self::V;
2286 /// }
2287 ///
2288 /// impl Tr for E {
2289 /// type V = u8;
2290 /// // `Self::V` is ambiguous because it may refer to the associated type or
2291 /// // the enum variant.
2292 /// fn foo() -> Self::V { 0 }
2293 /// }
2294 /// ```
2295 ///
2296 /// {{produces}}
2297 ///
2298 /// ### Explanation
2299 ///
2300 /// Previous versions of Rust did not allow accessing enum variants
2301 /// through [type aliases]. When this ability was added (see [RFC 2338]), this
2302 /// introduced some situations where it can be ambiguous what a type
2303 /// was referring to.
2304 ///
2305 /// To fix this ambiguity, you should use a [qualified path] to explicitly
2306 /// state which type to use. For example, in the above example the
2307 /// function can be written as `fn f() -> <Self as Tr>::V { 0 }` to
2308 /// specifically refer to the associated type.
2309 ///
2310 /// This is a [future-incompatible] lint to transition this to a hard
2311 /// error in the future. See [issue #57644] for more details.
2312 ///
2313 /// [issue #57644]: https://github.com/rust-lang/rust/issues/57644
2314 /// [type aliases]: https://doc.rust-lang.org/reference/items/type-aliases.html#type-aliases
2315 /// [RFC 2338]: https://github.com/rust-lang/rfcs/blob/master/text/2338-type-alias-enum-variants.md
2316 /// [qualified path]: https://doc.rust-lang.org/reference/paths.html#qualified-paths
2317 /// [future-incompatible]: ../index.md#future-incompatible-lints
2318pub AMBIGUOUS_ASSOCIATED_ITEMS,
2319 Deny,
2320"ambiguous associated items",
2321 @future_incompatible = FutureIncompatibleInfo {
2322 reason: fcw!(FutureReleaseError #57644),
2323 };
2324}23252326#[doc =
r" The `soft_unstable` lint detects unstable features that were unintentionally allowed on"]
#[doc =
r" stable. This is a [future-incompatible] lint to transition this to a hard error in the"]
#[doc = r" future. See [issue #64266] for more details."]
#[doc = r""]
#[doc = r" [issue #64266]: https://github.com/rust-lang/rust/issues/64266"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static SOFT_UNSTABLE: &crate::Lint =
&crate::Lint {
name: "SOFT_UNSTABLE",
default_level: crate::Deny,
desc: "a feature gate that doesn't break dependent crates",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 64266,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2327/// The `soft_unstable` lint detects unstable features that were unintentionally allowed on
2328 /// stable. This is a [future-incompatible] lint to transition this to a hard error in the
2329 /// future. See [issue #64266] for more details.
2330 ///
2331 /// [issue #64266]: https://github.com/rust-lang/rust/issues/64266
2332 /// [future-incompatible]: ../index.md#future-incompatible-lints
2333pub SOFT_UNSTABLE,
2334 Deny,
2335"a feature gate that doesn't break dependent crates",
2336 @future_incompatible = FutureIncompatibleInfo {
2337 reason: fcw!(FutureReleaseError #64266),
2338 report_in_deps: true,
2339 };
2340}23412342#[doc = r" The `inline_no_sanitize` lint detects incompatible use of"]
#[doc =
r#" [`#[inline(always)]`][inline] and [`#[sanitize(xyz = "off")]`][sanitize]."#]
#[doc = r""]
#[doc =
r" [inline]: https://doc.rust-lang.org/reference/attributes/codegen.html#the-inline-attribute"]
#[doc =
r" [sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![feature(sanitize)]"]
#[doc = r""]
#[doc = r" #[inline(always)]"]
#[doc = r#" #[sanitize(address = "off")]"#]
#[doc = r" fn x() {}"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" x()"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The use of the [`#[inline(always)]`][inline] attribute prevents the"]
#[doc =
r#" the [`#[sanitize(xyz = "off")]`][sanitize] attribute from working."#]
#[doc = r" Consider temporarily removing `inline` attribute."]
pub static INLINE_NO_SANITIZE: &crate::Lint =
&crate::Lint {
name: "INLINE_NO_SANITIZE",
default_level: crate::Warn,
desc: r#"detects incompatible use of `#[inline(always)]` and `#[sanitize(... = "off")]`"#,
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2343/// The `inline_no_sanitize` lint detects incompatible use of
2344 /// [`#[inline(always)]`][inline] and [`#[sanitize(xyz = "off")]`][sanitize].
2345 ///
2346 /// [inline]: https://doc.rust-lang.org/reference/attributes/codegen.html#the-inline-attribute
2347 /// [sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html
2348 ///
2349 /// ### Example
2350 ///
2351 /// ```rust
2352 /// #![feature(sanitize)]
2353 ///
2354 /// #[inline(always)]
2355 /// #[sanitize(address = "off")]
2356 /// fn x() {}
2357 ///
2358 /// fn main() {
2359 /// x()
2360 /// }
2361 /// ```
2362 ///
2363 /// {{produces}}
2364 ///
2365 /// ### Explanation
2366 ///
2367 /// The use of the [`#[inline(always)]`][inline] attribute prevents the
2368 /// the [`#[sanitize(xyz = "off")]`][sanitize] attribute from working.
2369 /// Consider temporarily removing `inline` attribute.
2370pub INLINE_NO_SANITIZE,
2371 Warn,
2372r#"detects incompatible use of `#[inline(always)]` and `#[sanitize(... = "off")]`"#,
2373}23742375#[doc = r" The `rtsan_nonblocking_async` lint detects incompatible use of"]
#[doc =
r#" [`#[sanitize(realtime = "nonblocking")]`][sanitize] on async functions."#]
#[doc = r""]
#[doc =
r" [sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html"]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,no_run"]
#[doc = r" #![feature(sanitize)]"]
#[doc = r""]
#[doc = r#" #[sanitize(realtime = "nonblocking")]"#]
#[doc = r" async fn x() {}"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" x();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The sanitizer only considers the async function body nonblocking. The executor, which runs on"]
#[doc =
r" every `.await` point can run non-realtime code, without the sanitizer catching it."]
pub static RTSAN_NONBLOCKING_ASYNC: &crate::Lint =
&crate::Lint {
name: "RTSAN_NONBLOCKING_ASYNC",
default_level: crate::Warn,
desc: r#"detects incompatible uses of `#[sanitize(realtime = "nonblocking")]` on async functions"#,
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2376/// The `rtsan_nonblocking_async` lint detects incompatible use of
2377 /// [`#[sanitize(realtime = "nonblocking")]`][sanitize] on async functions.
2378 ///
2379 /// [sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html
2380 /// ### Example
2381 ///
2382 /// ```rust,no_run
2383 /// #![feature(sanitize)]
2384 ///
2385 /// #[sanitize(realtime = "nonblocking")]
2386 /// async fn x() {}
2387 ///
2388 /// fn main() {
2389 /// x();
2390 /// }
2391 /// ```
2392 ///
2393 /// {{produces}}
2394 ///
2395 /// ### Explanation
2396 ///
2397 /// The sanitizer only considers the async function body nonblocking. The executor, which runs on
2398 /// every `.await` point can run non-realtime code, without the sanitizer catching it.
2399pub RTSAN_NONBLOCKING_ASYNC,
2400 Warn,
2401r#"detects incompatible uses of `#[sanitize(realtime = "nonblocking")]` on async functions"#,
2402}24032404#[doc =
r" The `asm_sub_register` lint detects using only a subset of a register"]
#[doc = r" for inline asm inputs."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (fails on non-x86_64)"]
#[doc = r#" #[cfg(target_arch="x86_64")]"#]
#[doc = r" use std::arch::asm;"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r#" #[cfg(target_arch="x86_64")]"#]
#[doc = r" unsafe {"]
#[doc = r#" asm!("mov {0}, {0}", in(reg) 0i16);"#]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: formatting may not be suitable for sub-register argument"]
#[doc = r" --> src/main.rs:7:19"]
#[doc = r" |"]
#[doc = r#" 7 | asm!("mov {0}, {0}", in(reg) 0i16);"#]
#[doc = r" | ^^^ ^^^ ---- for this argument"]
#[doc = r" |"]
#[doc = r" = note: `#[warn(asm_sub_register)]` on by default"]
#[doc =
r" = help: use the `x` modifier to have the register formatted as `ax`"]
#[doc =
r" = help: or use the `r` modifier to keep the default formatting of `rax`"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Registers on some architectures can use different names to refer to a"]
#[doc =
r" subset of the register. By default, the compiler will use the name for"]
#[doc =
r" the full register size. To explicitly use a subset of the register,"]
#[doc = r" you can override the default by using a modifier on the template"]
#[doc =
r" string operand to specify when subregister to use. This lint is issued"]
#[doc = r" if you pass in a value with a smaller data type than the default"]
#[doc =
r" register size, to alert you of possibly using the incorrect width. To"]
#[doc = r" fix this, add the suggested modifier to the template, or cast the"]
#[doc = r" value to the correct size."]
#[doc = r""]
#[doc =
r" See [register template modifiers] in the reference for more details."]
#[doc = r""]
#[doc =
r" [register template modifiers]: https://doc.rust-lang.org/nightly/reference/inline-assembly.html#template-modifiers"]
pub static ASM_SUB_REGISTER: &crate::Lint =
&crate::Lint {
name: "ASM_SUB_REGISTER",
default_level: crate::Warn,
desc: "using only a subset of a register for inline asm inputs",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2405/// The `asm_sub_register` lint detects using only a subset of a register
2406 /// for inline asm inputs.
2407 ///
2408 /// ### Example
2409 ///
2410 /// ```rust,ignore (fails on non-x86_64)
2411 /// #[cfg(target_arch="x86_64")]
2412 /// use std::arch::asm;
2413 ///
2414 /// fn main() {
2415 /// #[cfg(target_arch="x86_64")]
2416 /// unsafe {
2417 /// asm!("mov {0}, {0}", in(reg) 0i16);
2418 /// }
2419 /// }
2420 /// ```
2421 ///
2422 /// This will produce:
2423 ///
2424 /// ```text
2425 /// warning: formatting may not be suitable for sub-register argument
2426 /// --> src/main.rs:7:19
2427 /// |
2428 /// 7 | asm!("mov {0}, {0}", in(reg) 0i16);
2429 /// | ^^^ ^^^ ---- for this argument
2430 /// |
2431 /// = note: `#[warn(asm_sub_register)]` on by default
2432 /// = help: use the `x` modifier to have the register formatted as `ax`
2433 /// = help: or use the `r` modifier to keep the default formatting of `rax`
2434 /// ```
2435 ///
2436 /// ### Explanation
2437 ///
2438 /// Registers on some architectures can use different names to refer to a
2439 /// subset of the register. By default, the compiler will use the name for
2440 /// the full register size. To explicitly use a subset of the register,
2441 /// you can override the default by using a modifier on the template
2442 /// string operand to specify when subregister to use. This lint is issued
2443 /// if you pass in a value with a smaller data type than the default
2444 /// register size, to alert you of possibly using the incorrect width. To
2445 /// fix this, add the suggested modifier to the template, or cast the
2446 /// value to the correct size.
2447 ///
2448 /// See [register template modifiers] in the reference for more details.
2449 ///
2450 /// [register template modifiers]: https://doc.rust-lang.org/nightly/reference/inline-assembly.html#template-modifiers
2451pub ASM_SUB_REGISTER,
2452 Warn,
2453"using only a subset of a register for inline asm inputs",
2454}24552456#[doc =
r" The `bad_asm_style` lint detects the use of the `.intel_syntax` and"]
#[doc = r" `.att_syntax` directives."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (fails on non-x86_64)"]
#[doc = r#" #[cfg(target_arch="x86_64")]"#]
#[doc = r" use std::arch::asm;"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r#" #[cfg(target_arch="x86_64")]"#]
#[doc = r" unsafe {"]
#[doc = r" asm!("]
#[doc = r#" ".att_syntax","#]
#[doc = r#" "movq %{0}, %{0}", in(reg) 0usize"#]
#[doc = r" );"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" warning: avoid using `.att_syntax`, prefer using `options(att_syntax)` instead"]
#[doc = r" --> src/main.rs:8:14"]
#[doc = r" |"]
#[doc = r#" 8 | ".att_syntax","#]
#[doc = r" | ^^^^^^^^^^^"]
#[doc = r" |"]
#[doc = r" = note: `#[warn(bad_asm_style)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" On x86, `asm!` uses the intel assembly syntax by default. While this"]
#[doc =
r" can be switched using assembler directives like `.att_syntax`, using the"]
#[doc =
r" `att_syntax` option is recommended instead because it will also properly"]
#[doc = r" prefix register placeholders with `%` as required by AT&T syntax."]
pub static BAD_ASM_STYLE: &crate::Lint =
&crate::Lint {
name: "BAD_ASM_STYLE",
default_level: crate::Warn,
desc: "incorrect use of inline assembly",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2457/// The `bad_asm_style` lint detects the use of the `.intel_syntax` and
2458 /// `.att_syntax` directives.
2459 ///
2460 /// ### Example
2461 ///
2462 /// ```rust,ignore (fails on non-x86_64)
2463 /// #[cfg(target_arch="x86_64")]
2464 /// use std::arch::asm;
2465 ///
2466 /// fn main() {
2467 /// #[cfg(target_arch="x86_64")]
2468 /// unsafe {
2469 /// asm!(
2470 /// ".att_syntax",
2471 /// "movq %{0}, %{0}", in(reg) 0usize
2472 /// );
2473 /// }
2474 /// }
2475 /// ```
2476 ///
2477 /// This will produce:
2478 ///
2479 /// ```text
2480 /// warning: avoid using `.att_syntax`, prefer using `options(att_syntax)` instead
2481 /// --> src/main.rs:8:14
2482 /// |
2483 /// 8 | ".att_syntax",
2484 /// | ^^^^^^^^^^^
2485 /// |
2486 /// = note: `#[warn(bad_asm_style)]` on by default
2487 /// ```
2488 ///
2489 /// ### Explanation
2490 ///
2491 /// On x86, `asm!` uses the intel assembly syntax by default. While this
2492 /// can be switched using assembler directives like `.att_syntax`, using the
2493 /// `att_syntax` option is recommended instead because it will also properly
2494 /// prefix register placeholders with `%` as required by AT&T syntax.
2495pub BAD_ASM_STYLE,
2496 Warn,
2497"incorrect use of inline assembly",
2498}24992500#[doc =
r" The `unsafe_op_in_unsafe_fn` lint detects unsafe operations in unsafe"]
#[doc = r" functions without an explicit unsafe block."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(unsafe_op_in_unsafe_fn)]"]
#[doc = r""]
#[doc = r" unsafe fn foo() {}"]
#[doc = r""]
#[doc = r" unsafe fn bar() {"]
#[doc = r" foo();"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Currently, an [`unsafe fn`] allows any [unsafe] operation within its"]
#[doc =
r" body. However, this can increase the surface area of code that needs"]
#[doc =
r" to be scrutinized for proper behavior. The [`unsafe` block] provides a"]
#[doc =
r" convenient way to make it clear exactly which parts of the code are"]
#[doc =
r" performing unsafe operations. In the future, it is desired to change"]
#[doc =
r" it so that unsafe operations cannot be performed in an `unsafe fn`"]
#[doc = r" without an `unsafe` block."]
#[doc = r""]
#[doc = r" The fix to this is to wrap the unsafe code in an `unsafe` block."]
#[doc = r""]
#[doc =
r#" This lint is "allow" by default on editions up to 2021, from 2024 it is"#]
#[doc = r#" "warn" by default; the plan for increasing severity further is"#]
#[doc =
r" still being considered. See [RFC #2585] and [issue #71668] for more"]
#[doc = r" details."]
#[doc = r""]
#[doc =
r" [`unsafe fn`]: https://doc.rust-lang.org/reference/unsafe-functions.html"]
#[doc =
r" [`unsafe` block]: https://doc.rust-lang.org/reference/expressions/block-expr.html#unsafe-blocks"]
#[doc = r" [unsafe]: https://doc.rust-lang.org/reference/unsafety.html"]
#[doc =
r" [RFC #2585]: https://github.com/rust-lang/rfcs/blob/master/text/2585-unsafe-block-in-unsafe-fn.md"]
#[doc = r" [issue #71668]: https://github.com/rust-lang/rust/issues/71668"]
pub static UNSAFE_OP_IN_UNSAFE_FN: &crate::Lint =
&crate::Lint {
name: "UNSAFE_OP_IN_UNSAFE_FN",
default_level: crate::Allow,
desc: "unsafe operations in unsafe functions without an explicit unsafe block are deprecated",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "unsafe-op-in-unsafe-fn",
}),
explain_reason: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
edition_lint_opts: Some((crate::Edition::Edition2024,
crate::Warn)),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2501/// The `unsafe_op_in_unsafe_fn` lint detects unsafe operations in unsafe
2502 /// functions without an explicit unsafe block.
2503 ///
2504 /// ### Example
2505 ///
2506 /// ```rust,compile_fail
2507 /// #![deny(unsafe_op_in_unsafe_fn)]
2508 ///
2509 /// unsafe fn foo() {}
2510 ///
2511 /// unsafe fn bar() {
2512 /// foo();
2513 /// }
2514 ///
2515 /// fn main() {}
2516 /// ```
2517 ///
2518 /// {{produces}}
2519 ///
2520 /// ### Explanation
2521 ///
2522 /// Currently, an [`unsafe fn`] allows any [unsafe] operation within its
2523 /// body. However, this can increase the surface area of code that needs
2524 /// to be scrutinized for proper behavior. The [`unsafe` block] provides a
2525 /// convenient way to make it clear exactly which parts of the code are
2526 /// performing unsafe operations. In the future, it is desired to change
2527 /// it so that unsafe operations cannot be performed in an `unsafe fn`
2528 /// without an `unsafe` block.
2529 ///
2530 /// The fix to this is to wrap the unsafe code in an `unsafe` block.
2531 ///
2532 /// This lint is "allow" by default on editions up to 2021, from 2024 it is
2533 /// "warn" by default; the plan for increasing severity further is
2534 /// still being considered. See [RFC #2585] and [issue #71668] for more
2535 /// details.
2536 ///
2537 /// [`unsafe fn`]: https://doc.rust-lang.org/reference/unsafe-functions.html
2538 /// [`unsafe` block]: https://doc.rust-lang.org/reference/expressions/block-expr.html#unsafe-blocks
2539 /// [unsafe]: https://doc.rust-lang.org/reference/unsafety.html
2540 /// [RFC #2585]: https://github.com/rust-lang/rfcs/blob/master/text/2585-unsafe-block-in-unsafe-fn.md
2541 /// [issue #71668]: https://github.com/rust-lang/rust/issues/71668
2542pub UNSAFE_OP_IN_UNSAFE_FN,
2543 Allow,
2544"unsafe operations in unsafe functions without an explicit unsafe block are deprecated",
2545 @future_incompatible = FutureIncompatibleInfo {
2546 reason: fcw!(EditionError 2024 "unsafe-op-in-unsafe-fn"),
2547 explain_reason: false
2548};
2549 @edition Edition2024 => Warn;
2550}25512552#[doc =
r" The `fuzzy_provenance_casts` lint detects an `as` cast between an integer"]
#[doc = r" and a pointer."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![feature(strict_provenance_lints)]"]
#[doc = r" #![warn(fuzzy_provenance_casts)]"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" let _dangling = 16_usize as *const u8;"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This lint is part of the strict provenance effort, see [issue #95228]."]
#[doc =
r" Casting an integer to a pointer is considered bad style, as a pointer"]
#[doc =
r" contains, besides the *address* also a *provenance*, indicating what"]
#[doc =
r" memory the pointer is allowed to read/write. Casting an integer, which"]
#[doc =
r" doesn't have provenance, to a pointer requires the compiler to assign"]
#[doc =
r#" (guess) provenance. The compiler assigns "all exposed valid" (see the"#]
#[doc =
r" docs of [`ptr::with_exposed_provenance`] for more information about this"]
#[doc =
r#" "exposing"). This penalizes the optimiser and is not well suited for"#]
#[doc = r" dynamic analysis/dynamic program verification (e.g. Miri or CHERI"]
#[doc = r" platforms)."]
#[doc = r""]
#[doc =
r" It is much better to use [`ptr::with_addr`] instead to specify the"]
#[doc =
r" provenance you want. If using this function is not possible because the"]
#[doc =
r" code relies on exposed provenance then there is as an escape hatch"]
#[doc = r" [`ptr::with_exposed_provenance`]."]
#[doc = r""]
#[doc = r" [issue #95228]: https://github.com/rust-lang/rust/issues/95228"]
#[doc =
r" [`ptr::with_addr`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.with_addr"]
#[doc =
r" [`ptr::with_exposed_provenance`]: https://doc.rust-lang.org/core/ptr/fn.with_exposed_provenance.html"]
pub static FUZZY_PROVENANCE_CASTS: &crate::Lint =
&crate::Lint {
name: "FUZZY_PROVENANCE_CASTS",
default_level: crate::Allow,
desc: "a fuzzy integer to pointer cast is used",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::strict_provenance_lints),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2553/// The `fuzzy_provenance_casts` lint detects an `as` cast between an integer
2554 /// and a pointer.
2555 ///
2556 /// ### Example
2557 ///
2558 /// ```rust
2559 /// #![feature(strict_provenance_lints)]
2560 /// #![warn(fuzzy_provenance_casts)]
2561 ///
2562 /// fn main() {
2563 /// let _dangling = 16_usize as *const u8;
2564 /// }
2565 /// ```
2566 ///
2567 /// {{produces}}
2568 ///
2569 /// ### Explanation
2570 ///
2571 /// This lint is part of the strict provenance effort, see [issue #95228].
2572 /// Casting an integer to a pointer is considered bad style, as a pointer
2573 /// contains, besides the *address* also a *provenance*, indicating what
2574 /// memory the pointer is allowed to read/write. Casting an integer, which
2575 /// doesn't have provenance, to a pointer requires the compiler to assign
2576 /// (guess) provenance. The compiler assigns "all exposed valid" (see the
2577 /// docs of [`ptr::with_exposed_provenance`] for more information about this
2578 /// "exposing"). This penalizes the optimiser and is not well suited for
2579 /// dynamic analysis/dynamic program verification (e.g. Miri or CHERI
2580 /// platforms).
2581 ///
2582 /// It is much better to use [`ptr::with_addr`] instead to specify the
2583 /// provenance you want. If using this function is not possible because the
2584 /// code relies on exposed provenance then there is as an escape hatch
2585 /// [`ptr::with_exposed_provenance`].
2586 ///
2587 /// [issue #95228]: https://github.com/rust-lang/rust/issues/95228
2588 /// [`ptr::with_addr`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.with_addr
2589 /// [`ptr::with_exposed_provenance`]: https://doc.rust-lang.org/core/ptr/fn.with_exposed_provenance.html
2590pub FUZZY_PROVENANCE_CASTS,
2591 Allow,
2592"a fuzzy integer to pointer cast is used",
2593 @feature_gate = strict_provenance_lints;
2594}25952596#[doc =
r" The `lossy_provenance_casts` lint detects an `as` cast between a pointer"]
#[doc = r" and an integer."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![feature(strict_provenance_lints)]"]
#[doc = r" #![warn(lossy_provenance_casts)]"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" let x: u8 = 37;"]
#[doc = r" let _addr: usize = &x as *const u8 as usize;"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This lint is part of the strict provenance effort, see [issue #95228]."]
#[doc =
r" Casting a pointer to an integer is a lossy operation, because beyond"]
#[doc = r" just an *address* a pointer may be associated with a particular"]
#[doc =
r" *provenance*. This information is used by the optimiser and for dynamic"]
#[doc =
r" analysis/dynamic program verification (e.g. Miri or CHERI platforms)."]
#[doc = r""]
#[doc = r" Since this cast is lossy, it is considered good style to use the"]
#[doc =
r" [`ptr::addr`] method instead, which has a similar effect, but doesn't"]
#[doc =
r#" "expose" the pointer provenance. This improves optimisation potential."#]
#[doc =
r" See the docs of [`ptr::addr`] and [`ptr::expose_provenance`] for more information"]
#[doc = r" about exposing pointer provenance."]
#[doc = r""]
#[doc =
r" If your code can't comply with strict provenance and needs to expose"]
#[doc =
r" the provenance, then there is [`ptr::expose_provenance`] as an escape hatch,"]
#[doc =
r" which preserves the behaviour of `as usize` casts while being explicit"]
#[doc = r" about the semantics."]
#[doc = r""]
#[doc = r" [issue #95228]: https://github.com/rust-lang/rust/issues/95228"]
#[doc =
r" [`ptr::addr`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.addr"]
#[doc =
r" [`ptr::expose_provenance`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.expose_provenance"]
pub static LOSSY_PROVENANCE_CASTS: &crate::Lint =
&crate::Lint {
name: "LOSSY_PROVENANCE_CASTS",
default_level: crate::Allow,
desc: "a lossy pointer to integer cast is used",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::strict_provenance_lints),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2597/// The `lossy_provenance_casts` lint detects an `as` cast between a pointer
2598 /// and an integer.
2599 ///
2600 /// ### Example
2601 ///
2602 /// ```rust
2603 /// #![feature(strict_provenance_lints)]
2604 /// #![warn(lossy_provenance_casts)]
2605 ///
2606 /// fn main() {
2607 /// let x: u8 = 37;
2608 /// let _addr: usize = &x as *const u8 as usize;
2609 /// }
2610 /// ```
2611 ///
2612 /// {{produces}}
2613 ///
2614 /// ### Explanation
2615 ///
2616 /// This lint is part of the strict provenance effort, see [issue #95228].
2617 /// Casting a pointer to an integer is a lossy operation, because beyond
2618 /// just an *address* a pointer may be associated with a particular
2619 /// *provenance*. This information is used by the optimiser and for dynamic
2620 /// analysis/dynamic program verification (e.g. Miri or CHERI platforms).
2621 ///
2622 /// Since this cast is lossy, it is considered good style to use the
2623 /// [`ptr::addr`] method instead, which has a similar effect, but doesn't
2624 /// "expose" the pointer provenance. This improves optimisation potential.
2625 /// See the docs of [`ptr::addr`] and [`ptr::expose_provenance`] for more information
2626 /// about exposing pointer provenance.
2627 ///
2628 /// If your code can't comply with strict provenance and needs to expose
2629 /// the provenance, then there is [`ptr::expose_provenance`] as an escape hatch,
2630 /// which preserves the behaviour of `as usize` casts while being explicit
2631 /// about the semantics.
2632 ///
2633 /// [issue #95228]: https://github.com/rust-lang/rust/issues/95228
2634 /// [`ptr::addr`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.addr
2635 /// [`ptr::expose_provenance`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.expose_provenance
2636pub LOSSY_PROVENANCE_CASTS,
2637 Allow,
2638"a lossy pointer to integer cast is used",
2639 @feature_gate = strict_provenance_lints;
2640}26412642#[doc =
r" The `const_evaluatable_unchecked` lint detects a generic constant used"]
#[doc = r" in a type."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" const fn foo<T>() -> usize {"]
#[doc =
r" if size_of::<*mut T>() < 8 { // size of *mut T does not depend on T"]
#[doc = r" 4"]
#[doc = r" } else {"]
#[doc = r" 8"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn test<T>() {"]
#[doc = r" let _ = [0; foo::<T>()];"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In the 1.43 release, some uses of generic parameters in array repeat"]
#[doc =
r" expressions were accidentally allowed. This is a [future-incompatible]"]
#[doc = r" lint to transition this to a hard error in the future. See [issue"]
#[doc = r" #76200] for a more detailed description and possible fixes."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
#[doc = r" [issue #76200]: https://github.com/rust-lang/rust/issues/76200"]
pub static CONST_EVALUATABLE_UNCHECKED: &crate::Lint =
&crate::Lint {
name: "CONST_EVALUATABLE_UNCHECKED",
default_level: crate::Warn,
desc: "detects a generic constant is used in a type without a emitting a warning",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 76200,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2643/// The `const_evaluatable_unchecked` lint detects a generic constant used
2644 /// in a type.
2645 ///
2646 /// ### Example
2647 ///
2648 /// ```rust
2649 /// const fn foo<T>() -> usize {
2650 /// if size_of::<*mut T>() < 8 { // size of *mut T does not depend on T
2651 /// 4
2652 /// } else {
2653 /// 8
2654 /// }
2655 /// }
2656 ///
2657 /// fn test<T>() {
2658 /// let _ = [0; foo::<T>()];
2659 /// }
2660 /// ```
2661 ///
2662 /// {{produces}}
2663 ///
2664 /// ### Explanation
2665 ///
2666 /// In the 1.43 release, some uses of generic parameters in array repeat
2667 /// expressions were accidentally allowed. This is a [future-incompatible]
2668 /// lint to transition this to a hard error in the future. See [issue
2669 /// #76200] for a more detailed description and possible fixes.
2670 ///
2671 /// [future-incompatible]: ../index.md#future-incompatible-lints
2672 /// [issue #76200]: https://github.com/rust-lang/rust/issues/76200
2673pub CONST_EVALUATABLE_UNCHECKED,
2674 Warn,
2675"detects a generic constant is used in a type without a emitting a warning",
2676 @future_incompatible = FutureIncompatibleInfo {
2677 reason: fcw!(FutureReleaseError #76200),
2678 };
2679}26802681#[doc =
r" The `function_item_references` lint detects function references that are"]
#[doc = r" formatted with [`fmt::Pointer`] or transmuted."]
#[doc = r""]
#[doc =
r" [`fmt::Pointer`]: https://doc.rust-lang.org/std/fmt/trait.Pointer.html"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" fn foo() { }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r#" println!("{:p}", &foo);"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Taking a reference to a function may be mistaken as a way to obtain a"]
#[doc = r" pointer to that function. This can give unexpected results when"]
#[doc =
r" formatting the reference as a pointer or transmuting it. This lint is"]
#[doc =
r" issued when function references are formatted as pointers, passed as"]
#[doc = r" arguments bound by [`fmt::Pointer`] or transmuted."]
pub static FUNCTION_ITEM_REFERENCES: &crate::Lint =
&crate::Lint {
name: "FUNCTION_ITEM_REFERENCES",
default_level: crate::Warn,
desc: "suggest casting to a function pointer when attempting to take references to function items",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2682/// The `function_item_references` lint detects function references that are
2683 /// formatted with [`fmt::Pointer`] or transmuted.
2684 ///
2685 /// [`fmt::Pointer`]: https://doc.rust-lang.org/std/fmt/trait.Pointer.html
2686 ///
2687 /// ### Example
2688 ///
2689 /// ```rust
2690 /// fn foo() { }
2691 ///
2692 /// fn main() {
2693 /// println!("{:p}", &foo);
2694 /// }
2695 /// ```
2696 ///
2697 /// {{produces}}
2698 ///
2699 /// ### Explanation
2700 ///
2701 /// Taking a reference to a function may be mistaken as a way to obtain a
2702 /// pointer to that function. This can give unexpected results when
2703 /// formatting the reference as a pointer or transmuting it. This lint is
2704 /// issued when function references are formatted as pointers, passed as
2705 /// arguments bound by [`fmt::Pointer`] or transmuted.
2706pub FUNCTION_ITEM_REFERENCES,
2707 Warn,
2708"suggest casting to a function pointer when attempting to take references to function items",
2709}27102711#[doc = r" The `uninhabited_static` lint detects uninhabited statics."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" enum Void {}"]
#[doc = r" unsafe extern {"]
#[doc = r" static EXTERN: Void;"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Statics with an uninhabited type can never be initialized, so they are impossible to define."]
#[doc =
r" However, this can be side-stepped with an `extern static`, leading to problems later in the"]
#[doc =
r" compiler which assumes that there are no initialized uninhabited places (such as locals or"]
#[doc = r" statics). This was accidentally allowed, but is being phased out."]
pub static UNINHABITED_STATIC: &crate::Lint =
&crate::Lint {
name: "UNINHABITED_STATIC",
default_level: crate::Warn,
desc: "uninhabited static",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 74840,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2712/// The `uninhabited_static` lint detects uninhabited statics.
2713 ///
2714 /// ### Example
2715 ///
2716 /// ```rust
2717 /// enum Void {}
2718 /// unsafe extern {
2719 /// static EXTERN: Void;
2720 /// }
2721 /// ```
2722 ///
2723 /// {{produces}}
2724 ///
2725 /// ### Explanation
2726 ///
2727 /// Statics with an uninhabited type can never be initialized, so they are impossible to define.
2728 /// However, this can be side-stepped with an `extern static`, leading to problems later in the
2729 /// compiler which assumes that there are no initialized uninhabited places (such as locals or
2730 /// statics). This was accidentally allowed, but is being phased out.
2731pub UNINHABITED_STATIC,
2732 Warn,
2733"uninhabited static",
2734 @future_incompatible = FutureIncompatibleInfo {
2735 reason: fcw!(FutureReleaseError #74840),
2736 };
2737}27382739#[doc =
r" The `unnameable_test_items` lint detects [`#[test]`][test] functions"]
#[doc =
r" that are not able to be run by the test harness because they are in a"]
#[doc = r" position where they are not nameable."]
#[doc = r""]
#[doc =
r" [test]: https://doc.rust-lang.org/reference/attributes/testing.html#the-test-attribute"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,test"]
#[doc = r" fn main() {"]
#[doc = r" #[test]"]
#[doc = r" fn foo() {"]
#[doc = r" // This test will not fail because it does not run."]
#[doc = r" assert_eq!(1, 2);"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In order for the test harness to run a test, the test function must be"]
#[doc =
r" located in a position where it can be accessed from the crate root."]
#[doc =
r" This generally means it must be defined in a module, and not anywhere"]
#[doc =
r" else such as inside another function. The compiler previously allowed"]
#[doc =
r" this without an error, so a lint was added as an alert that a test is"]
#[doc =
r" not being used. Whether or not this should be allowed has not yet been"]
#[doc = r" decided, see [RFC 2471] and [issue #36629]."]
#[doc = r""]
#[doc =
r" [RFC 2471]: https://github.com/rust-lang/rfcs/pull/2471#issuecomment-397414443"]
#[doc = r" [issue #36629]: https://github.com/rust-lang/rust/issues/36629"]
pub static UNNAMEABLE_TEST_ITEMS: &crate::Lint =
&crate::Lint {
name: "UNNAMEABLE_TEST_ITEMS",
default_level: crate::Warn,
desc: "detects an item that cannot be named being marked as `#[test_case]`",
is_externally_loaded: false,
report_in_external_macro: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2740/// The `unnameable_test_items` lint detects [`#[test]`][test] functions
2741 /// that are not able to be run by the test harness because they are in a
2742 /// position where they are not nameable.
2743 ///
2744 /// [test]: https://doc.rust-lang.org/reference/attributes/testing.html#the-test-attribute
2745 ///
2746 /// ### Example
2747 ///
2748 /// ```rust,test
2749 /// fn main() {
2750 /// #[test]
2751 /// fn foo() {
2752 /// // This test will not fail because it does not run.
2753 /// assert_eq!(1, 2);
2754 /// }
2755 /// }
2756 /// ```
2757 ///
2758 /// {{produces}}
2759 ///
2760 /// ### Explanation
2761 ///
2762 /// In order for the test harness to run a test, the test function must be
2763 /// located in a position where it can be accessed from the crate root.
2764 /// This generally means it must be defined in a module, and not anywhere
2765 /// else such as inside another function. The compiler previously allowed
2766 /// this without an error, so a lint was added as an alert that a test is
2767 /// not being used. Whether or not this should be allowed has not yet been
2768 /// decided, see [RFC 2471] and [issue #36629].
2769 ///
2770 /// [RFC 2471]: https://github.com/rust-lang/rfcs/pull/2471#issuecomment-397414443
2771 /// [issue #36629]: https://github.com/rust-lang/rust/issues/36629
2772pub UNNAMEABLE_TEST_ITEMS,
2773 Warn,
2774"detects an item that cannot be named being marked as `#[test_case]`",
2775 report_in_external_macro
2776}27772778#[doc =
r" The `useless_deprecated` lint detects deprecation attributes with no effect."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" struct X;"]
#[doc = r""]
#[doc = r#" #[deprecated = "message"]"#]
#[doc = r" impl Default for X {"]
#[doc = r" fn default() -> Self {"]
#[doc = r" X"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Deprecation attributes have no effect on trait implementations."]
pub static USELESS_DEPRECATED: &crate::Lint =
&crate::Lint {
name: "USELESS_DEPRECATED",
default_level: crate::Deny,
desc: "detects deprecation attributes with no effect",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2779/// The `useless_deprecated` lint detects deprecation attributes with no effect.
2780 ///
2781 /// ### Example
2782 ///
2783 /// ```rust,compile_fail
2784 /// struct X;
2785 ///
2786 /// #[deprecated = "message"]
2787 /// impl Default for X {
2788 /// fn default() -> Self {
2789 /// X
2790 /// }
2791 /// }
2792 /// ```
2793 ///
2794 /// {{produces}}
2795 ///
2796 /// ### Explanation
2797 ///
2798 /// Deprecation attributes have no effect on trait implementations.
2799pub USELESS_DEPRECATED,
2800 Deny,
2801"detects deprecation attributes with no effect",
2802}28032804#[doc =
r" The `ineffective_unstable_trait_impl` lint detects `#[unstable]` attributes which are not used."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![feature(staged_api)]"]
#[doc = r""]
#[doc = r" #[derive(Clone)]"]
#[doc = r#" #[stable(feature = "x", since = "1")]"#]
#[doc = r" struct S {}"]
#[doc = r""]
#[doc = r#" #[unstable(feature = "y", issue = "none")]"#]
#[doc = r" impl Copy for S {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" `staged_api` does not currently support using a stability attribute on `impl` blocks."]
#[doc =
r" `impl`s are always stable if both the type and trait are stable, and always unstable otherwise."]
pub static INEFFECTIVE_UNSTABLE_TRAIT_IMPL: &crate::Lint =
&crate::Lint {
name: "INEFFECTIVE_UNSTABLE_TRAIT_IMPL",
default_level: crate::Deny,
desc: "detects `#[unstable]` on stable trait implementations for stable types",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2805/// The `ineffective_unstable_trait_impl` lint detects `#[unstable]` attributes which are not used.
2806 ///
2807 /// ### Example
2808 ///
2809 /// ```rust,compile_fail
2810 /// #![feature(staged_api)]
2811 ///
2812 /// #[derive(Clone)]
2813 /// #[stable(feature = "x", since = "1")]
2814 /// struct S {}
2815 ///
2816 /// #[unstable(feature = "y", issue = "none")]
2817 /// impl Copy for S {}
2818 /// ```
2819 ///
2820 /// {{produces}}
2821 ///
2822 /// ### Explanation
2823 ///
2824 /// `staged_api` does not currently support using a stability attribute on `impl` blocks.
2825 /// `impl`s are always stable if both the type and trait are stable, and always unstable otherwise.
2826pub INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
2827 Deny,
2828"detects `#[unstable]` on stable trait implementations for stable types"
2829}28302831#[doc =
r" The `self_constructor_from_outer_item` lint detects cases where the `Self` constructor"]
#[doc =
r" was silently allowed due to a bug in the resolver, and which may produce surprising"]
#[doc = r" and unintended behavior."]
#[doc = r""]
#[doc =
r" Using a `Self` type alias from an outer item was never intended, but was silently allowed."]
#[doc =
r" This is deprecated -- and is a hard error when the `Self` type alias references generics"]
#[doc = r" that are not in scope."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(self_constructor_from_outer_item)]"]
#[doc = r""]
#[doc = r" struct S0(usize);"]
#[doc = r""]
#[doc = r" impl S0 {"]
#[doc = r" fn foo() {"]
#[doc = r" const C: S0 = Self(0);"]
#[doc = r" fn bar() -> S0 {"]
#[doc = r" Self(0)"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The `Self` type alias should not be reachable because nested items are not associated with"]
#[doc = r" the scope of the parameters from the parent item."]
pub static SELF_CONSTRUCTOR_FROM_OUTER_ITEM: &crate::Lint =
&crate::Lint {
name: "SELF_CONSTRUCTOR_FROM_OUTER_ITEM",
default_level: crate::Warn,
desc: "detect unsupported use of `Self` from outer item",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 124186,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2832/// The `self_constructor_from_outer_item` lint detects cases where the `Self` constructor
2833 /// was silently allowed due to a bug in the resolver, and which may produce surprising
2834 /// and unintended behavior.
2835 ///
2836 /// Using a `Self` type alias from an outer item was never intended, but was silently allowed.
2837 /// This is deprecated -- and is a hard error when the `Self` type alias references generics
2838 /// that are not in scope.
2839 ///
2840 /// ### Example
2841 ///
2842 /// ```rust,compile_fail
2843 /// #![deny(self_constructor_from_outer_item)]
2844 ///
2845 /// struct S0(usize);
2846 ///
2847 /// impl S0 {
2848 /// fn foo() {
2849 /// const C: S0 = Self(0);
2850 /// fn bar() -> S0 {
2851 /// Self(0)
2852 /// }
2853 /// }
2854 /// }
2855 /// ```
2856 ///
2857 /// {{produces}}
2858 ///
2859 /// ### Explanation
2860 ///
2861 /// The `Self` type alias should not be reachable because nested items are not associated with
2862 /// the scope of the parameters from the parent item.
2863pub SELF_CONSTRUCTOR_FROM_OUTER_ITEM,
2864 Warn,
2865"detect unsupported use of `Self` from outer item",
2866 @future_incompatible = FutureIncompatibleInfo {
2867 reason: fcw!(FutureReleaseError #124186),
2868 };
2869}28702871#[doc =
r" The `semicolon_in_expressions_from_macros` lint detects trailing semicolons"]
#[doc = r" in macro bodies when the macro is invoked in expression position."]
#[doc = r" This was previous accepted, but is being phased out."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(semicolon_in_expressions_from_macros)]"]
#[doc = r" macro_rules! foo {"]
#[doc = r" () => { true; }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" let val = match true {"]
#[doc = r" true => false,"]
#[doc = r" _ => foo!()"]
#[doc = r" };"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Previous, Rust ignored trailing semicolon in a macro"]
#[doc = r" body when a macro was invoked in expression position."]
#[doc = r" However, this makes the treatment of semicolons in the language"]
#[doc = r" inconsistent, and could lead to unexpected runtime behavior"]
#[doc = r" in some circumstances (e.g. if the macro author expects"]
#[doc = r" a value to be dropped)."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this"]
#[doc =
r" to a hard error in the future. See [issue #79813] for more details."]
#[doc = r""]
#[doc = r" [issue #79813]: https://github.com/rust-lang/rust/issues/79813"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static SEMICOLON_IN_EXPRESSIONS_FROM_MACROS: &crate::Lint =
&crate::Lint {
name: "SEMICOLON_IN_EXPRESSIONS_FROM_MACROS",
default_level: crate::Deny,
desc: "trailing semicolon in macro body used as expression",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 79813,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2872/// The `semicolon_in_expressions_from_macros` lint detects trailing semicolons
2873 /// in macro bodies when the macro is invoked in expression position.
2874 /// This was previous accepted, but is being phased out.
2875 ///
2876 /// ### Example
2877 ///
2878 /// ```rust,compile_fail
2879 /// #![deny(semicolon_in_expressions_from_macros)]
2880 /// macro_rules! foo {
2881 /// () => { true; }
2882 /// }
2883 ///
2884 /// fn main() {
2885 /// let val = match true {
2886 /// true => false,
2887 /// _ => foo!()
2888 /// };
2889 /// }
2890 /// ```
2891 ///
2892 /// {{produces}}
2893 ///
2894 /// ### Explanation
2895 ///
2896 /// Previous, Rust ignored trailing semicolon in a macro
2897 /// body when a macro was invoked in expression position.
2898 /// However, this makes the treatment of semicolons in the language
2899 /// inconsistent, and could lead to unexpected runtime behavior
2900 /// in some circumstances (e.g. if the macro author expects
2901 /// a value to be dropped).
2902 ///
2903 /// This is a [future-incompatible] lint to transition this
2904 /// to a hard error in the future. See [issue #79813] for more details.
2905 ///
2906 /// [issue #79813]: https://github.com/rust-lang/rust/issues/79813
2907 /// [future-incompatible]: ../index.md#future-incompatible-lints
2908pub SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
2909 Deny,
2910"trailing semicolon in macro body used as expression",
2911 @future_incompatible = FutureIncompatibleInfo {
2912 reason: fcw!(FutureReleaseError #79813),
2913 report_in_deps: true,
2914 };
2915}29162917#[doc = r" The `legacy_derive_helpers` lint detects derive helper attributes"]
#[doc = r" that are used before they are introduced."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs extern crate)"]
#[doc = r#" #[serde(rename_all = "camelCase")]"#]
#[doc = r" #[derive(Deserialize)]"]
#[doc = r" struct S { /* fields */ }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" produces:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: derive helper attribute is used before it is introduced"]
#[doc = r" --> $DIR/legacy-derive-helpers.rs:1:3"]
#[doc = r" |"]
#[doc = r#" 1 | #[serde(rename_all = "camelCase")]"#]
#[doc = r" | ^^^^^"]
#[doc = r" ..."]
#[doc = r" 2 | #[derive(Deserialize)]"]
#[doc = r" | ----------- the attribute is introduced here"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Attributes like this work for historical reasons, but attribute expansion works in"]
#[doc =
r#" left-to-right order in general, so, to resolve `#[serde]`, compiler has to try to "look"#]
#[doc =
r#" into the future" at not yet expanded part of the item , but such attempts are not always"#]
#[doc = r" reliable."]
#[doc = r""]
#[doc =
r" To fix the warning place the helper attribute after its corresponding derive."]
#[doc = r" ```rust,ignore (needs extern crate)"]
#[doc = r" #[derive(Deserialize)]"]
#[doc = r#" #[serde(rename_all = "camelCase")]"#]
#[doc = r" struct S { /* fields */ }"]
#[doc = r" ```"]
pub static LEGACY_DERIVE_HELPERS: &crate::Lint =
&crate::Lint {
name: "LEGACY_DERIVE_HELPERS",
default_level: crate::Deny,
desc: "detects derive helper attributes that are used before they are introduced",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 79202,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2918/// The `legacy_derive_helpers` lint detects derive helper attributes
2919 /// that are used before they are introduced.
2920 ///
2921 /// ### Example
2922 ///
2923 /// ```rust,ignore (needs extern crate)
2924 /// #[serde(rename_all = "camelCase")]
2925 /// #[derive(Deserialize)]
2926 /// struct S { /* fields */ }
2927 /// ```
2928 ///
2929 /// produces:
2930 ///
2931 /// ```text
2932 /// warning: derive helper attribute is used before it is introduced
2933 /// --> $DIR/legacy-derive-helpers.rs:1:3
2934 /// |
2935 /// 1 | #[serde(rename_all = "camelCase")]
2936 /// | ^^^^^
2937 /// ...
2938 /// 2 | #[derive(Deserialize)]
2939 /// | ----------- the attribute is introduced here
2940 /// ```
2941 ///
2942 /// ### Explanation
2943 ///
2944 /// Attributes like this work for historical reasons, but attribute expansion works in
2945 /// left-to-right order in general, so, to resolve `#[serde]`, compiler has to try to "look
2946 /// into the future" at not yet expanded part of the item , but such attempts are not always
2947 /// reliable.
2948 ///
2949 /// To fix the warning place the helper attribute after its corresponding derive.
2950 /// ```rust,ignore (needs extern crate)
2951 /// #[derive(Deserialize)]
2952 /// #[serde(rename_all = "camelCase")]
2953 /// struct S { /* fields */ }
2954 /// ```
2955pub LEGACY_DERIVE_HELPERS,
2956 Deny,
2957"detects derive helper attributes that are used before they are introduced",
2958 @future_incompatible = FutureIncompatibleInfo {
2959 reason: fcw!(FutureReleaseError #79202),
2960 report_in_deps: true,
2961 };
2962}29632964#[doc = r" The `large_assignments` lint detects when objects of large"]
#[doc = r" types are being moved around."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (can crash on some platforms)"]
#[doc = r" let x = [0; 50000];"]
#[doc = r" let y = x;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" produces:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: moving a large value"]
#[doc = r" --> $DIR/move-large.rs:1:3"]
#[doc = r" let y = x;"]
#[doc = r" - Copied large value here"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" When using a large type in a plain assignment or in a function"]
#[doc = r" argument, idiomatic code can be inefficient."]
#[doc = r" Ideally appropriate optimizations would resolve this, but such"]
#[doc = r" optimizations are only done in a best-effort manner."]
#[doc =
r" This lint will trigger on all sites of large moves and thus allow the"]
#[doc = r" user to resolve them in code."]
pub static LARGE_ASSIGNMENTS: &crate::Lint =
&crate::Lint {
name: "LARGE_ASSIGNMENTS",
default_level: crate::Warn,
desc: "detects large moves or copies",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2965/// The `large_assignments` lint detects when objects of large
2966 /// types are being moved around.
2967 ///
2968 /// ### Example
2969 ///
2970 /// ```rust,ignore (can crash on some platforms)
2971 /// let x = [0; 50000];
2972 /// let y = x;
2973 /// ```
2974 ///
2975 /// produces:
2976 ///
2977 /// ```text
2978 /// warning: moving a large value
2979 /// --> $DIR/move-large.rs:1:3
2980 /// let y = x;
2981 /// - Copied large value here
2982 /// ```
2983 ///
2984 /// ### Explanation
2985 ///
2986 /// When using a large type in a plain assignment or in a function
2987 /// argument, idiomatic code can be inefficient.
2988 /// Ideally appropriate optimizations would resolve this, but such
2989 /// optimizations are only done in a best-effort manner.
2990 /// This lint will trigger on all sites of large moves and thus allow the
2991 /// user to resolve them in code.
2992pub LARGE_ASSIGNMENTS,
2993 Warn,
2994"detects large moves or copies",
2995}29962997#[doc =
r" The `unexpected_cfgs` lint detects unexpected conditional compilation conditions."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" rustc --check-cfg 'cfg()'"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs command line option)"]
#[doc = r" #[cfg(widnows)]"]
#[doc = r" fn foo() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: unexpected `cfg` condition name: `widnows`"]
#[doc = r" --> lint_example.rs:1:7"]
#[doc = r" |"]
#[doc = r" 1 | #[cfg(widnows)]"]
#[doc = r" | ^^^^^^^"]
#[doc = r" |"]
#[doc = r" = note: `#[warn(unexpected_cfgs)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This lint is only active when [`--check-cfg`][check-cfg] arguments are being"]
#[doc =
r" passed to the compiler and triggers whenever an unexpected condition name or value is"]
#[doc = r" used."]
#[doc = r""]
#[doc =
r" See the [Checking Conditional Configurations][check-cfg] section for more"]
#[doc = r" details."]
#[doc = r""]
#[doc =
r" See the [Cargo Specifics][unexpected_cfgs_lint_config] section for configuring this lint in"]
#[doc = r" `Cargo.toml`."]
#[doc = r""]
#[doc =
r" [check-cfg]: https://doc.rust-lang.org/nightly/rustc/check-cfg.html"]
#[doc =
r" [unexpected_cfgs_lint_config]: https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html#check-cfg-in-lintsrust-table"]
pub static UNEXPECTED_CFGS: &crate::Lint =
&crate::Lint {
name: "UNEXPECTED_CFGS",
default_level: crate::Warn,
desc: "detects unexpected names and values in `#[cfg]` conditions",
is_externally_loaded: false,
report_in_external_macro: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2998/// The `unexpected_cfgs` lint detects unexpected conditional compilation conditions.
2999 ///
3000 /// ### Example
3001 ///
3002 /// ```text
3003 /// rustc --check-cfg 'cfg()'
3004 /// ```
3005 ///
3006 /// ```rust,ignore (needs command line option)
3007 /// #[cfg(widnows)]
3008 /// fn foo() {}
3009 /// ```
3010 ///
3011 /// This will produce:
3012 ///
3013 /// ```text
3014 /// warning: unexpected `cfg` condition name: `widnows`
3015 /// --> lint_example.rs:1:7
3016 /// |
3017 /// 1 | #[cfg(widnows)]
3018 /// | ^^^^^^^
3019 /// |
3020 /// = note: `#[warn(unexpected_cfgs)]` on by default
3021 /// ```
3022 ///
3023 /// ### Explanation
3024 ///
3025 /// This lint is only active when [`--check-cfg`][check-cfg] arguments are being
3026 /// passed to the compiler and triggers whenever an unexpected condition name or value is
3027 /// used.
3028 ///
3029 /// See the [Checking Conditional Configurations][check-cfg] section for more
3030 /// details.
3031 ///
3032 /// See the [Cargo Specifics][unexpected_cfgs_lint_config] section for configuring this lint in
3033 /// `Cargo.toml`.
3034 ///
3035 /// [check-cfg]: https://doc.rust-lang.org/nightly/rustc/check-cfg.html
3036 /// [unexpected_cfgs_lint_config]: https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html#check-cfg-in-lintsrust-table
3037pub UNEXPECTED_CFGS,
3038 Warn,
3039"detects unexpected names and values in `#[cfg]` conditions",
3040 report_in_external_macro
3041}30423043#[doc =
r" The `explicit_builtin_cfgs_in_flags` lint detects builtin cfgs set via the `--cfg` flag."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" rustc --cfg unix"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs command line option)"]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" error: unexpected `--cfg unix` flag"]
#[doc = r" |"]
#[doc =
r" = note: config `unix` is only supposed to be controlled by `--target`"]
#[doc =
r" = note: manually setting a built-in cfg can and does create incoherent behaviors"]
#[doc = r" = note: `#[deny(explicit_builtin_cfgs_in_flags)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Setting builtin cfgs can and does produce incoherent behavior, it's better to the use"]
#[doc =
r" the appropriate `rustc` flag that controls the config. For example setting the `windows`"]
#[doc = r" cfg but on Linux based target."]
pub static EXPLICIT_BUILTIN_CFGS_IN_FLAGS: &crate::Lint =
&crate::Lint {
name: "EXPLICIT_BUILTIN_CFGS_IN_FLAGS",
default_level: crate::Deny,
desc: "detects builtin cfgs set via the `--cfg`",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3044/// The `explicit_builtin_cfgs_in_flags` lint detects builtin cfgs set via the `--cfg` flag.
3045 ///
3046 /// ### Example
3047 ///
3048 /// ```text
3049 /// rustc --cfg unix
3050 /// ```
3051 ///
3052 /// ```rust,ignore (needs command line option)
3053 /// fn main() {}
3054 /// ```
3055 ///
3056 /// This will produce:
3057 ///
3058 /// ```text
3059 /// error: unexpected `--cfg unix` flag
3060 /// |
3061 /// = note: config `unix` is only supposed to be controlled by `--target`
3062 /// = note: manually setting a built-in cfg can and does create incoherent behaviors
3063 /// = note: `#[deny(explicit_builtin_cfgs_in_flags)]` on by default
3064 /// ```
3065 ///
3066 /// ### Explanation
3067 ///
3068 /// Setting builtin cfgs can and does produce incoherent behavior, it's better to the use
3069 /// the appropriate `rustc` flag that controls the config. For example setting the `windows`
3070 /// cfg but on Linux based target.
3071pub EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
3072 Deny,
3073"detects builtin cfgs set via the `--cfg`"
3074}30753076#[doc = r" The `repr_transparent_non_zst_fields` lint"]
#[doc = r" detects types marked `#[repr(transparent)]` that (transitively)"]
#[doc =
r" contain a type that is not guaranteed to remain a ZST type under all configurations."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs external crate)"]
#[doc = r" #![deny(repr_transparent_external_private_fields)]"]
#[doc = r" use foo::NonExhaustiveZst;"]
#[doc = r""]
#[doc = r" #[repr(C)]"]
#[doc = r" struct CZst([u8; 0]);"]
#[doc = r""]
#[doc = r" #[repr(transparent)]"]
#[doc = r" struct Bar(u32, ([u32; 0], NonExhaustiveZst));"]
#[doc = r" #[repr(transparent)]"]
#[doc = r" struct Baz(u32, CZst);"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" error: zero-sized fields in repr(transparent) cannot contain external non-exhaustive types"]
#[doc = r" --> src/main.rs:5:28"]
#[doc = r" |"]
#[doc = r" 5 | struct Bar(u32, ([u32; 0], NonExhaustiveZst));"]
#[doc = r" | ^^^^^^^^^^^^^^^^"]
#[doc = r" |"]
#[doc = r" note: the lint level is defined here"]
#[doc = r" --> src/main.rs:1:9"]
#[doc = r" |"]
#[doc = r" 1 | #![deny(repr_transparent_external_private_fields)]"]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!"]
#[doc =
r" = note: for more information, see issue #78586 <https://github.com/rust-lang/rust/issues/78586>"]
#[doc =
r" = note: this field contains `NonExhaustiveZst`, which is marked with `#[non_exhaustive]`, so it could become non-zero-sized in the future."]
#[doc = r""]
#[doc =
r" error: zero-sized fields in repr(transparent) cannot contain `#[repr(C)]` types"]
#[doc = r" --> src/main.rs:5:28"]
#[doc = r" |"]
#[doc = r" 5 | struct Baz(u32, CZst);"]
#[doc = r" | ^^^^"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!"]
#[doc =
r" = note: for more information, see issue #78586 <https://github.com/rust-lang/rust/issues/78586>"]
#[doc =
r" = note: this field contains `CZst`, which is a `#[repr(C)]` type, so it is not guaranteed to be zero-sized on all targets."]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Previous, Rust accepted fields that contain external private zero-sized types, even though"]
#[doc =
r" those types could gain a non-zero-sized field in a future, semver-compatible update."]
#[doc = r""]
#[doc =
r" Rust also accepted fields that contain `repr(C)` zero-sized types, even though those types"]
#[doc =
r" are not guaranteed to be zero-sized on all targets, and even though those types can"]
#[doc =
r" make a difference for the ABI (and therefore cannot be ignored by `repr(transparent)`)."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this"]
#[doc =
r" to a hard error in the future. See [issue #78586] for more details."]
#[doc = r""]
#[doc = r" [issue #78586]: https://github.com/rust-lang/rust/issues/78586"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static REPR_TRANSPARENT_NON_ZST_FIELDS: &crate::Lint =
&crate::Lint {
name: "REPR_TRANSPARENT_NON_ZST_FIELDS",
default_level: crate::Deny,
desc: "transparent type contains an external ZST that is marked #[non_exhaustive] or contains private fields",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 78586,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3077/// The `repr_transparent_non_zst_fields` lint
3078 /// detects types marked `#[repr(transparent)]` that (transitively)
3079 /// contain a type that is not guaranteed to remain a ZST type under all configurations.
3080 ///
3081 /// ### Example
3082 ///
3083 /// ```rust,ignore (needs external crate)
3084 /// #![deny(repr_transparent_external_private_fields)]
3085 /// use foo::NonExhaustiveZst;
3086 ///
3087 /// #[repr(C)]
3088 /// struct CZst([u8; 0]);
3089 ///
3090 /// #[repr(transparent)]
3091 /// struct Bar(u32, ([u32; 0], NonExhaustiveZst));
3092 /// #[repr(transparent)]
3093 /// struct Baz(u32, CZst);
3094 /// ```
3095 ///
3096 /// This will produce:
3097 ///
3098 /// ```text
3099 /// error: zero-sized fields in repr(transparent) cannot contain external non-exhaustive types
3100 /// --> src/main.rs:5:28
3101 /// |
3102 /// 5 | struct Bar(u32, ([u32; 0], NonExhaustiveZst));
3103 /// | ^^^^^^^^^^^^^^^^
3104 /// |
3105 /// note: the lint level is defined here
3106 /// --> src/main.rs:1:9
3107 /// |
3108 /// 1 | #![deny(repr_transparent_external_private_fields)]
3109 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3110 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3111 /// = note: for more information, see issue #78586 <https://github.com/rust-lang/rust/issues/78586>
3112 /// = note: this field contains `NonExhaustiveZst`, which is marked with `#[non_exhaustive]`, so it could become non-zero-sized in the future.
3113 ///
3114 /// error: zero-sized fields in repr(transparent) cannot contain `#[repr(C)]` types
3115 /// --> src/main.rs:5:28
3116 /// |
3117 /// 5 | struct Baz(u32, CZst);
3118 /// | ^^^^
3119 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3120 /// = note: for more information, see issue #78586 <https://github.com/rust-lang/rust/issues/78586>
3121 /// = note: this field contains `CZst`, which is a `#[repr(C)]` type, so it is not guaranteed to be zero-sized on all targets.
3122 /// ```
3123 ///
3124 /// ### Explanation
3125 ///
3126 /// Previous, Rust accepted fields that contain external private zero-sized types, even though
3127 /// those types could gain a non-zero-sized field in a future, semver-compatible update.
3128 ///
3129 /// Rust also accepted fields that contain `repr(C)` zero-sized types, even though those types
3130 /// are not guaranteed to be zero-sized on all targets, and even though those types can
3131 /// make a difference for the ABI (and therefore cannot be ignored by `repr(transparent)`).
3132 ///
3133 /// This is a [future-incompatible] lint to transition this
3134 /// to a hard error in the future. See [issue #78586] for more details.
3135 ///
3136 /// [issue #78586]: https://github.com/rust-lang/rust/issues/78586
3137 /// [future-incompatible]: ../index.md#future-incompatible-lints
3138pub REPR_TRANSPARENT_NON_ZST_FIELDS,
3139 Deny,
3140"transparent type contains an external ZST that is marked #[non_exhaustive] or contains private fields",
3141 @future_incompatible = FutureIncompatibleInfo {
3142 reason: fcw!(FutureReleaseError #78586),
3143 report_in_deps: true,
3144 };
3145}31463147#[doc =
r" The `unstable_syntax_pre_expansion` lint detects the use of unstable"]
#[doc = r" syntax that is discarded during attribute expansion."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #[cfg(FALSE)]"]
#[doc = r" macro foo() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The input to active attributes such as `#[cfg]` or procedural macro"]
#[doc =
r" attributes is required to be valid syntax. Previously, the compiler only"]
#[doc =
r" gated the use of unstable syntax features after resolving `#[cfg]` gates"]
#[doc = r" and expanding procedural macros."]
#[doc = r""]
#[doc =
r" To avoid relying on unstable syntax, move the use of unstable syntax"]
#[doc =
r" into a position where the compiler does not parse the syntax, such as a"]
#[doc = r" functionlike macro."]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" # #![deny(unstable_syntax_pre_expansion)]"]
#[doc = r""]
#[doc = r" macro_rules! identity {"]
#[doc = r" ( $($tokens:tt)* ) => { $($tokens)* }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" #[cfg(FALSE)]"]
#[doc = r" identity! {"]
#[doc = r" macro foo() {}"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this"]
#[doc =
r" to a hard error in the future. See [issue #65860] for more details."]
#[doc = r""]
#[doc = r" [issue #65860]: https://github.com/rust-lang/rust/issues/65860"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static UNSTABLE_SYNTAX_PRE_EXPANSION: &crate::Lint =
&crate::Lint {
name: "UNSTABLE_SYNTAX_PRE_EXPANSION",
default_level: crate::Warn,
desc: "unstable syntax can change at any point in the future, causing a hard error!",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 65860,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3148/// The `unstable_syntax_pre_expansion` lint detects the use of unstable
3149 /// syntax that is discarded during attribute expansion.
3150 ///
3151 /// ### Example
3152 ///
3153 /// ```rust
3154 /// #[cfg(FALSE)]
3155 /// macro foo() {}
3156 /// ```
3157 ///
3158 /// {{produces}}
3159 ///
3160 /// ### Explanation
3161 ///
3162 /// The input to active attributes such as `#[cfg]` or procedural macro
3163 /// attributes is required to be valid syntax. Previously, the compiler only
3164 /// gated the use of unstable syntax features after resolving `#[cfg]` gates
3165 /// and expanding procedural macros.
3166 ///
3167 /// To avoid relying on unstable syntax, move the use of unstable syntax
3168 /// into a position where the compiler does not parse the syntax, such as a
3169 /// functionlike macro.
3170 ///
3171 /// ```rust
3172 /// # #![deny(unstable_syntax_pre_expansion)]
3173 ///
3174 /// macro_rules! identity {
3175 /// ( $($tokens:tt)* ) => { $($tokens)* }
3176 /// }
3177 ///
3178 /// #[cfg(FALSE)]
3179 /// identity! {
3180 /// macro foo() {}
3181 /// }
3182 /// ```
3183 ///
3184 /// This is a [future-incompatible] lint to transition this
3185 /// to a hard error in the future. See [issue #65860] for more details.
3186 ///
3187 /// [issue #65860]: https://github.com/rust-lang/rust/issues/65860
3188 /// [future-incompatible]: ../index.md#future-incompatible-lints
3189pub UNSTABLE_SYNTAX_PRE_EXPANSION,
3190 Warn,
3191"unstable syntax can change at any point in the future, causing a hard error!",
3192 @future_incompatible = FutureIncompatibleInfo {
3193 reason: fcw!(FutureReleaseError #65860),
3194 };
3195}31963197#[doc =
r" The `ambiguous_glob_reexports` lint detects cases where names re-exported via globs"]
#[doc =
r" collide. Downstream users trying to use the same name re-exported from multiple globs"]
#[doc =
r" will receive a warning pointing out redefinition of the same name."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(ambiguous_glob_reexports)]"]
#[doc = r" pub mod foo {"]
#[doc = r" pub type X = u8;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" pub mod bar {"]
#[doc = r" pub type Y = u8;"]
#[doc = r" pub type X = u8;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" pub use foo::*;"]
#[doc = r" pub use bar::*;"]
#[doc = r""]
#[doc = r""]
#[doc = r" pub fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This was previously accepted but it could silently break a crate's downstream users code."]
#[doc =
r" For example, if `foo::*` and `bar::*` were re-exported before `bar::X` was added to the"]
#[doc =
r" re-exports, down stream users could use `this_crate::X` without problems. However, adding"]
#[doc =
r" `bar::X` would cause compilation errors in downstream crates because `X` is defined"]
#[doc = r" multiple times in the same namespace of `this_crate`."]
pub static AMBIGUOUS_GLOB_REEXPORTS: &crate::Lint =
&crate::Lint {
name: "AMBIGUOUS_GLOB_REEXPORTS",
default_level: crate::Warn,
desc: "ambiguous glob re-exports",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3198/// The `ambiguous_glob_reexports` lint detects cases where names re-exported via globs
3199 /// collide. Downstream users trying to use the same name re-exported from multiple globs
3200 /// will receive a warning pointing out redefinition of the same name.
3201 ///
3202 /// ### Example
3203 ///
3204 /// ```rust,compile_fail
3205 /// #![deny(ambiguous_glob_reexports)]
3206 /// pub mod foo {
3207 /// pub type X = u8;
3208 /// }
3209 ///
3210 /// pub mod bar {
3211 /// pub type Y = u8;
3212 /// pub type X = u8;
3213 /// }
3214 ///
3215 /// pub use foo::*;
3216 /// pub use bar::*;
3217 ///
3218 ///
3219 /// pub fn main() {}
3220 /// ```
3221 ///
3222 /// {{produces}}
3223 ///
3224 /// ### Explanation
3225 ///
3226 /// This was previously accepted but it could silently break a crate's downstream users code.
3227 /// For example, if `foo::*` and `bar::*` were re-exported before `bar::X` was added to the
3228 /// re-exports, down stream users could use `this_crate::X` without problems. However, adding
3229 /// `bar::X` would cause compilation errors in downstream crates because `X` is defined
3230 /// multiple times in the same namespace of `this_crate`.
3231pub AMBIGUOUS_GLOB_REEXPORTS,
3232 Warn,
3233"ambiguous glob re-exports",
3234}32353236#[doc =
r" The `hidden_glob_reexports` lint detects cases where glob re-export items are shadowed by"]
#[doc = r" private items."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(hidden_glob_reexports)]"]
#[doc = r""]
#[doc = r" pub mod upstream {"]
#[doc = r" mod inner { pub struct Foo {}; pub struct Bar {}; }"]
#[doc = r" pub use self::inner::*;"]
#[doc = r" struct Foo {} // private item shadows `inner::Foo`"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" // mod downstream {"]
#[doc = r" // fn test() {"]
#[doc = r" // let _ = crate::upstream::Foo; // inaccessible"]
#[doc = r" // }"]
#[doc = r" // }"]
#[doc = r""]
#[doc = r" pub fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" This was previously accepted without any errors or warnings but it could silently break a"]
#[doc =
r" crate's downstream user code. If the `struct Foo` was added, `dep::inner::Foo` would"]
#[doc =
r#" silently become inaccessible and trigger a "`struct `Foo` is private`" visibility error at"#]
#[doc = r" the downstream use site."]
pub static HIDDEN_GLOB_REEXPORTS: &crate::Lint =
&crate::Lint {
name: "HIDDEN_GLOB_REEXPORTS",
default_level: crate::Warn,
desc: "name introduced by a private item shadows a name introduced by a public glob re-export",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3237/// The `hidden_glob_reexports` lint detects cases where glob re-export items are shadowed by
3238 /// private items.
3239 ///
3240 /// ### Example
3241 ///
3242 /// ```rust,compile_fail
3243 /// #![deny(hidden_glob_reexports)]
3244 ///
3245 /// pub mod upstream {
3246 /// mod inner { pub struct Foo {}; pub struct Bar {}; }
3247 /// pub use self::inner::*;
3248 /// struct Foo {} // private item shadows `inner::Foo`
3249 /// }
3250 ///
3251 /// // mod downstream {
3252 /// // fn test() {
3253 /// // let _ = crate::upstream::Foo; // inaccessible
3254 /// // }
3255 /// // }
3256 ///
3257 /// pub fn main() {}
3258 /// ```
3259 ///
3260 /// {{produces}}
3261 ///
3262 /// ### Explanation
3263 ///
3264 /// This was previously accepted without any errors or warnings but it could silently break a
3265 /// crate's downstream user code. If the `struct Foo` was added, `dep::inner::Foo` would
3266 /// silently become inaccessible and trigger a "`struct `Foo` is private`" visibility error at
3267 /// the downstream use site.
3268pub HIDDEN_GLOB_REEXPORTS,
3269 Warn,
3270"name introduced by a private item shadows a name introduced by a public glob re-export",
3271}32723273#[doc = r" The `long_running_const_eval` lint is emitted when const"]
#[doc = r" eval is running for a long time to ensure rustc terminates"]
#[doc = r" even if you accidentally wrote an infinite loop."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" const FOO: () = loop {};"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Loops allow const evaluation to compute arbitrary code, but may also"]
#[doc = r" cause infinite loops or just very long running computations."]
#[doc = r" Users can enable long running computations by allowing the lint"]
#[doc = r" on individual constants or for entire crates."]
#[doc = r""]
#[doc = r" ### Unconditional warnings"]
#[doc = r""]
#[doc =
r" Note that regardless of whether the lint is allowed or set to warn,"]
#[doc =
r" the compiler will issue warnings if constant evaluation runs significantly"]
#[doc =
r" longer than this lint's limit. These warnings are also shown to downstream"]
#[doc =
r" users from crates.io or similar registries. If you are above the lint's limit,"]
#[doc = r" both you and downstream users might be exposed to these warnings."]
#[doc =
r" They might also appear on compiler updates, as the compiler makes minor changes"]
#[doc =
r" about how complexity is measured: staying below the limit ensures that there"]
#[doc =
r" is enough room, and given that the lint is disabled for people who use your"]
#[doc =
r" dependency it means you will be the only one to get the warning and can put"]
#[doc = r" out an update in your own time."]
pub static LONG_RUNNING_CONST_EVAL: &crate::Lint =
&crate::Lint {
name: "LONG_RUNNING_CONST_EVAL",
default_level: crate::Deny,
desc: "detects long const eval operations",
is_externally_loaded: false,
report_in_external_macro: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3274/// The `long_running_const_eval` lint is emitted when const
3275 /// eval is running for a long time to ensure rustc terminates
3276 /// even if you accidentally wrote an infinite loop.
3277 ///
3278 /// ### Example
3279 ///
3280 /// ```rust,compile_fail
3281 /// const FOO: () = loop {};
3282 /// ```
3283 ///
3284 /// {{produces}}
3285 ///
3286 /// ### Explanation
3287 ///
3288 /// Loops allow const evaluation to compute arbitrary code, but may also
3289 /// cause infinite loops or just very long running computations.
3290 /// Users can enable long running computations by allowing the lint
3291 /// on individual constants or for entire crates.
3292 ///
3293 /// ### Unconditional warnings
3294 ///
3295 /// Note that regardless of whether the lint is allowed or set to warn,
3296 /// the compiler will issue warnings if constant evaluation runs significantly
3297 /// longer than this lint's limit. These warnings are also shown to downstream
3298 /// users from crates.io or similar registries. If you are above the lint's limit,
3299 /// both you and downstream users might be exposed to these warnings.
3300 /// They might also appear on compiler updates, as the compiler makes minor changes
3301 /// about how complexity is measured: staying below the limit ensures that there
3302 /// is enough room, and given that the lint is disabled for people who use your
3303 /// dependency it means you will be the only one to get the warning and can put
3304 /// out an update in your own time.
3305pub LONG_RUNNING_CONST_EVAL,
3306 Deny,
3307"detects long const eval operations",
3308 report_in_external_macro
3309}33103311#[doc = r" The `unused_associated_type_bounds` lint is emitted when an"]
#[doc =
r" associated type bound is added to a trait object, but the associated"]
#[doc =
r" type has a `where Self: Sized` bound, and is thus unavailable on the"]
#[doc = r" trait object anyway."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" trait Foo {"]
#[doc = r" type Bar where Self: Sized;"]
#[doc = r" }"]
#[doc = r" type Mop = dyn Foo<Bar = ()>;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Just like methods with `Self: Sized` bounds are unavailable on trait"]
#[doc = r" objects, associated types can be removed from the trait object."]
pub static UNUSED_ASSOCIATED_TYPE_BOUNDS: &crate::Lint =
&crate::Lint {
name: "UNUSED_ASSOCIATED_TYPE_BOUNDS",
default_level: crate::Warn,
desc: "detects unused `Foo = Bar` bounds in `dyn Trait<Foo = Bar>`",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3312/// The `unused_associated_type_bounds` lint is emitted when an
3313 /// associated type bound is added to a trait object, but the associated
3314 /// type has a `where Self: Sized` bound, and is thus unavailable on the
3315 /// trait object anyway.
3316 ///
3317 /// ### Example
3318 ///
3319 /// ```rust
3320 /// trait Foo {
3321 /// type Bar where Self: Sized;
3322 /// }
3323 /// type Mop = dyn Foo<Bar = ()>;
3324 /// ```
3325 ///
3326 /// {{produces}}
3327 ///
3328 /// ### Explanation
3329 ///
3330 /// Just like methods with `Self: Sized` bounds are unavailable on trait
3331 /// objects, associated types can be removed from the trait object.
3332pub UNUSED_ASSOCIATED_TYPE_BOUNDS,
3333 Warn,
3334"detects unused `Foo = Bar` bounds in `dyn Trait<Foo = Bar>`"
3335}33363337#[doc =
r" The `unused_doc_comments` lint detects doc comments that aren't used"]
#[doc = r" by `rustdoc`."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" /// docs for x"]
#[doc = r" let x = 12;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" `rustdoc` does not use doc comments in all positions, and so the doc"]
#[doc =
r" comment will be ignored. Try changing it to a normal comment with `//`"]
#[doc = r" to avoid the warning."]
pub static UNUSED_DOC_COMMENTS: &crate::Lint =
&crate::Lint {
name: "UNUSED_DOC_COMMENTS",
default_level: crate::Warn,
desc: "detects doc comments that aren't used by rustdoc",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3338/// The `unused_doc_comments` lint detects doc comments that aren't used
3339 /// by `rustdoc`.
3340 ///
3341 /// ### Example
3342 ///
3343 /// ```rust
3344 /// /// docs for x
3345 /// let x = 12;
3346 /// ```
3347 ///
3348 /// {{produces}}
3349 ///
3350 /// ### Explanation
3351 ///
3352 /// `rustdoc` does not use doc comments in all positions, and so the doc
3353 /// comment will be ignored. Try changing it to a normal comment with `//`
3354 /// to avoid the warning.
3355pub UNUSED_DOC_COMMENTS,
3356 Warn,
3357"detects doc comments that aren't used by rustdoc"
3358}33593360#[doc =
r" The `rust_2021_incompatible_closure_captures` lint detects variables that aren't completely"]
#[doc =
r" captured in Rust 2021, such that the `Drop` order of their fields may differ between"]
#[doc = r" Rust 2018 and 2021."]
#[doc = r""]
#[doc =
r" It can also detect when a variable implements a trait like `Send`, but one of its fields does not,"]
#[doc =
r" and the field is captured by a closure and used with the assumption that said field implements"]
#[doc = r" the same trait as the root variable."]
#[doc = r""]
#[doc = r" ### Example of drop reorder"]
#[doc = r""]
#[doc = r" ```rust,edition2018,compile_fail"]
#[doc = r" #![deny(rust_2021_incompatible_closure_captures)]"]
#[doc = r" # #![allow(unused)]"]
#[doc = r""]
#[doc = r" struct FancyInteger(i32);"]
#[doc = r""]
#[doc = r" impl Drop for FancyInteger {"]
#[doc = r" fn drop(&mut self) {"]
#[doc = r#" println!("Just dropped {}", self.0);"#]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" struct Point { x: FancyInteger, y: FancyInteger }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" let p = Point { x: FancyInteger(10), y: FancyInteger(20) };"]
#[doc = r""]
#[doc = r" let c = || {"]
#[doc = r" let x = p.x;"]
#[doc = r" };"]
#[doc = r""]
#[doc = r" c();"]
#[doc = r""]
#[doc = r" // ... More code ..."]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In the above example, `p.y` will be dropped at the end of `f` instead of"]
#[doc = r" with `c` in Rust 2021."]
#[doc = r""]
#[doc = r" ### Example of auto-trait"]
#[doc = r""]
#[doc = r" ```rust,edition2018,compile_fail"]
#[doc = r" #![deny(rust_2021_incompatible_closure_captures)]"]
#[doc = r" use std::thread;"]
#[doc = r""]
#[doc = r" struct Pointer(*mut i32);"]
#[doc = r" unsafe impl Send for Pointer {}"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" let mut f = 10;"]
#[doc = r" let fptr = Pointer(&mut f as *mut i32);"]
#[doc = r" thread::spawn(move || unsafe {"]
#[doc = r" *fptr.0 = 20;"]
#[doc = r" });"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" In the above example, only `fptr.0` is captured in Rust 2021."]
#[doc = r" The field is of type `*mut i32`, which doesn't implement `Send`,"]
#[doc =
r" making the code invalid as the field cannot be sent between threads safely."]
pub static RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES: &crate::Lint =
&crate::Lint {
name: "RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES",
default_level: crate::Allow,
desc: "detects closures affected by Rust 2021 changes",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionSemanticsChange(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2021,
page_slug: "disjoint-capture-in-closures",
}),
explain_reason: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3361/// The `rust_2021_incompatible_closure_captures` lint detects variables that aren't completely
3362 /// captured in Rust 2021, such that the `Drop` order of their fields may differ between
3363 /// Rust 2018 and 2021.
3364 ///
3365 /// It can also detect when a variable implements a trait like `Send`, but one of its fields does not,
3366 /// and the field is captured by a closure and used with the assumption that said field implements
3367 /// the same trait as the root variable.
3368 ///
3369 /// ### Example of drop reorder
3370 ///
3371 /// ```rust,edition2018,compile_fail
3372 /// #![deny(rust_2021_incompatible_closure_captures)]
3373 /// # #![allow(unused)]
3374 ///
3375 /// struct FancyInteger(i32);
3376 ///
3377 /// impl Drop for FancyInteger {
3378 /// fn drop(&mut self) {
3379 /// println!("Just dropped {}", self.0);
3380 /// }
3381 /// }
3382 ///
3383 /// struct Point { x: FancyInteger, y: FancyInteger }
3384 ///
3385 /// fn main() {
3386 /// let p = Point { x: FancyInteger(10), y: FancyInteger(20) };
3387 ///
3388 /// let c = || {
3389 /// let x = p.x;
3390 /// };
3391 ///
3392 /// c();
3393 ///
3394 /// // ... More code ...
3395 /// }
3396 /// ```
3397 ///
3398 /// {{produces}}
3399 ///
3400 /// ### Explanation
3401 ///
3402 /// In the above example, `p.y` will be dropped at the end of `f` instead of
3403 /// with `c` in Rust 2021.
3404 ///
3405 /// ### Example of auto-trait
3406 ///
3407 /// ```rust,edition2018,compile_fail
3408 /// #![deny(rust_2021_incompatible_closure_captures)]
3409 /// use std::thread;
3410 ///
3411 /// struct Pointer(*mut i32);
3412 /// unsafe impl Send for Pointer {}
3413 ///
3414 /// fn main() {
3415 /// let mut f = 10;
3416 /// let fptr = Pointer(&mut f as *mut i32);
3417 /// thread::spawn(move || unsafe {
3418 /// *fptr.0 = 20;
3419 /// });
3420 /// }
3421 /// ```
3422 ///
3423 /// {{produces}}
3424 ///
3425 /// ### Explanation
3426 ///
3427 /// In the above example, only `fptr.0` is captured in Rust 2021.
3428 /// The field is of type `*mut i32`, which doesn't implement `Send`,
3429 /// making the code invalid as the field cannot be sent between threads safely.
3430pub RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
3431 Allow,
3432"detects closures affected by Rust 2021 changes",
3433 @future_incompatible = FutureIncompatibleInfo {
3434 reason: fcw!(EditionSemanticsChange 2021 "disjoint-capture-in-closures"),
3435 explain_reason: false,
3436 };
3437}34383439pub struct UnusedDocComment;
#[automatically_derived]
impl ::core::marker::Copy for UnusedDocComment { }
#[automatically_derived]
#[doc(hidden)]
unsafe impl ::core::clone::TrivialClone for UnusedDocComment { }
#[automatically_derived]
impl ::core::clone::Clone for UnusedDocComment {
#[inline]
fn clone(&self) -> UnusedDocComment { *self }
}
impl crate::LintPass for UnusedDocComment {
fn name(&self) -> &'static str { "UnusedDocComment" }
fn get_lints(&self) -> crate::LintVec {
::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
[UNUSED_DOC_COMMENTS]))
}
}
impl UnusedDocComment {
#[allow(unused)]
pub fn lint_vec() -> crate::LintVec {
::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
[UNUSED_DOC_COMMENTS]))
}
}declare_lint_pass!(UnusedDocComment => [UNUSED_DOC_COMMENTS]);
34403441#[doc =
r" The `missing_abi` lint detects cases where the ABI is omitted from"]
#[doc = r" `extern` declarations."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(missing_abi)]"]
#[doc = r""]
#[doc = r" extern fn foo() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" For historic reasons, Rust implicitly selects `C` as the default ABI for"]
#[doc =
r" `extern` declarations. [Other ABIs] like `C-unwind` and `system` have"]
#[doc =
r" been added since then, and especially with their addition seeing the ABI"]
#[doc = r" easily makes code review easier."]
#[doc = r""]
#[doc =
r" [Other ABIs]: https://doc.rust-lang.org/reference/items/external-blocks.html#abi"]
pub static MISSING_ABI: &crate::Lint =
&crate::Lint {
name: "MISSING_ABI",
default_level: crate::Warn,
desc: "No declared ABI for extern declaration",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3442/// The `missing_abi` lint detects cases where the ABI is omitted from
3443 /// `extern` declarations.
3444 ///
3445 /// ### Example
3446 ///
3447 /// ```rust,compile_fail
3448 /// #![deny(missing_abi)]
3449 ///
3450 /// extern fn foo() {}
3451 /// ```
3452 ///
3453 /// {{produces}}
3454 ///
3455 /// ### Explanation
3456 ///
3457 /// For historic reasons, Rust implicitly selects `C` as the default ABI for
3458 /// `extern` declarations. [Other ABIs] like `C-unwind` and `system` have
3459 /// been added since then, and especially with their addition seeing the ABI
3460 /// easily makes code review easier.
3461 ///
3462 /// [Other ABIs]: https://doc.rust-lang.org/reference/items/external-blocks.html#abi
3463pub MISSING_ABI,
3464 Warn,
3465"No declared ABI for extern declaration"
3466}34673468#[doc =
r" The `invalid_doc_attributes` lint detects when the `#[doc(...)]` is"]
#[doc = r" misused."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(warnings)]"]
#[doc = r""]
#[doc = r" pub mod submodule {"]
#[doc = r" #![doc(test(no_crate_inject))]"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Previously, incorrect usage of the `#[doc(..)]` attribute was not"]
#[doc =
r" being validated. Usually these should be rejected as a hard error,"]
#[doc = r" but this lint was introduced to avoid breaking any existing"]
#[doc = r" crates which included them."]
pub static INVALID_DOC_ATTRIBUTES: &crate::Lint =
&crate::Lint {
name: "INVALID_DOC_ATTRIBUTES",
default_level: crate::Warn,
desc: "detects invalid `#[doc(...)]` attributes",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3469/// The `invalid_doc_attributes` lint detects when the `#[doc(...)]` is
3470 /// misused.
3471 ///
3472 /// ### Example
3473 ///
3474 /// ```rust,compile_fail
3475 /// #![deny(warnings)]
3476 ///
3477 /// pub mod submodule {
3478 /// #![doc(test(no_crate_inject))]
3479 /// }
3480 /// ```
3481 ///
3482 /// {{produces}}
3483 ///
3484 /// ### Explanation
3485 ///
3486 /// Previously, incorrect usage of the `#[doc(..)]` attribute was not
3487 /// being validated. Usually these should be rejected as a hard error,
3488 /// but this lint was introduced to avoid breaking any existing
3489 /// crates which included them.
3490pub INVALID_DOC_ATTRIBUTES,
3491 Warn,
3492"detects invalid `#[doc(...)]` attributes",
3493}34943495#[doc =
r" The `rust_2021_incompatible_or_patterns` lint detects usage of old versions of or-patterns."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2018,compile_fail"]
#[doc = r" #![deny(rust_2021_incompatible_or_patterns)]"]
#[doc = r""]
#[doc = r" macro_rules! match_any {"]
#[doc =
r" ( $expr:expr , $( $( $pat:pat )|+ => $expr_arm:expr ),+ ) => {"]
#[doc = r" match $expr {"]
#[doc = r" $("]
#[doc = r" $( $pat => $expr_arm, )+"]
#[doc = r" )+"]
#[doc = r" }"]
#[doc = r" };"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" let result: Result<i64, i32> = Err(42);"]
#[doc =
r" let int: i64 = match_any!(result, Ok(i) | Err(i) => i.into());"]
#[doc = r" assert_eq!(int, 42);"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In Rust 2021, the `pat` matcher will match additional patterns, which include the `|` character."]
pub static RUST_2021_INCOMPATIBLE_OR_PATTERNS: &crate::Lint =
&crate::Lint {
name: "RUST_2021_INCOMPATIBLE_OR_PATTERNS",
default_level: crate::Allow,
desc: "detects usage of old versions of or-patterns",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2021,
page_slug: "or-patterns-macro-rules",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3496/// The `rust_2021_incompatible_or_patterns` lint detects usage of old versions of or-patterns.
3497 ///
3498 /// ### Example
3499 ///
3500 /// ```rust,edition2018,compile_fail
3501 /// #![deny(rust_2021_incompatible_or_patterns)]
3502 ///
3503 /// macro_rules! match_any {
3504 /// ( $expr:expr , $( $( $pat:pat )|+ => $expr_arm:expr ),+ ) => {
3505 /// match $expr {
3506 /// $(
3507 /// $( $pat => $expr_arm, )+
3508 /// )+
3509 /// }
3510 /// };
3511 /// }
3512 ///
3513 /// fn main() {
3514 /// let result: Result<i64, i32> = Err(42);
3515 /// let int: i64 = match_any!(result, Ok(i) | Err(i) => i.into());
3516 /// assert_eq!(int, 42);
3517 /// }
3518 /// ```
3519 ///
3520 /// {{produces}}
3521 ///
3522 /// ### Explanation
3523 ///
3524 /// In Rust 2021, the `pat` matcher will match additional patterns, which include the `|` character.
3525pub RUST_2021_INCOMPATIBLE_OR_PATTERNS,
3526 Allow,
3527"detects usage of old versions of or-patterns",
3528 @future_incompatible = FutureIncompatibleInfo {
3529 reason: fcw!(EditionError 2021 "or-patterns-macro-rules"),
3530 };
3531}35323533#[doc =
r" The `rust_2021_prelude_collisions` lint detects the usage of trait methods which are ambiguous"]
#[doc = r" with traits added to the prelude in future editions."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2018,compile_fail"]
#[doc = r" #![deny(rust_2021_prelude_collisions)]"]
#[doc = r""]
#[doc = r" trait Foo {"]
#[doc = r" fn try_into(self) -> Result<String, !>;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl Foo for &str {"]
#[doc = r" fn try_into(self) -> Result<String, !> {"]
#[doc = r" Ok(String::from(self))"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r#" let x: String = "3".try_into().unwrap();"#]
#[doc = r" // ^^^^^^^^"]
#[doc =
r" // This call to try_into matches both Foo::try_into and TryInto::try_into as"]
#[doc =
r" // `TryInto` has been added to the Rust prelude in 2021 edition."]
#[doc = r#" println!("{x}");"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In Rust 2021, one of the important introductions is the [prelude changes], which add"]
#[doc =
r" `TryFrom`, `TryInto`, and `FromIterator` into the standard library's prelude. Since this"]
#[doc =
r" results in an ambiguity as to which method/function to call when an existing `try_into`"]
#[doc =
r" method is called via dot-call syntax or a `try_from`/`from_iter` associated function"]
#[doc = r" is called directly on a type."]
#[doc = r""]
#[doc =
r" [prelude changes]: https://blog.rust-lang.org/inside-rust/2021/03/04/planning-rust-2021.html#prelude-changes"]
pub static RUST_2021_PRELUDE_COLLISIONS: &crate::Lint =
&crate::Lint {
name: "RUST_2021_PRELUDE_COLLISIONS",
default_level: crate::Allow,
desc: "detects the usage of trait methods which are ambiguous with traits added to the \
prelude in future editions",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2021,
page_slug: "prelude",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3534/// The `rust_2021_prelude_collisions` lint detects the usage of trait methods which are ambiguous
3535 /// with traits added to the prelude in future editions.
3536 ///
3537 /// ### Example
3538 ///
3539 /// ```rust,edition2018,compile_fail
3540 /// #![deny(rust_2021_prelude_collisions)]
3541 ///
3542 /// trait Foo {
3543 /// fn try_into(self) -> Result<String, !>;
3544 /// }
3545 ///
3546 /// impl Foo for &str {
3547 /// fn try_into(self) -> Result<String, !> {
3548 /// Ok(String::from(self))
3549 /// }
3550 /// }
3551 ///
3552 /// fn main() {
3553 /// let x: String = "3".try_into().unwrap();
3554 /// // ^^^^^^^^
3555 /// // This call to try_into matches both Foo::try_into and TryInto::try_into as
3556 /// // `TryInto` has been added to the Rust prelude in 2021 edition.
3557 /// println!("{x}");
3558 /// }
3559 /// ```
3560 ///
3561 /// {{produces}}
3562 ///
3563 /// ### Explanation
3564 ///
3565 /// In Rust 2021, one of the important introductions is the [prelude changes], which add
3566 /// `TryFrom`, `TryInto`, and `FromIterator` into the standard library's prelude. Since this
3567 /// results in an ambiguity as to which method/function to call when an existing `try_into`
3568 /// method is called via dot-call syntax or a `try_from`/`from_iter` associated function
3569 /// is called directly on a type.
3570 ///
3571 /// [prelude changes]: https://blog.rust-lang.org/inside-rust/2021/03/04/planning-rust-2021.html#prelude-changes
3572pub RUST_2021_PRELUDE_COLLISIONS,
3573 Allow,
3574"detects the usage of trait methods which are ambiguous with traits added to the \
3575 prelude in future editions",
3576 @future_incompatible = FutureIncompatibleInfo {
3577 reason: fcw!(EditionError 2021 "prelude"),
3578 };
3579}35803581#[doc =
r" The `rust_2024_prelude_collisions` lint detects the usage of trait methods which are ambiguous"]
#[doc = r" with traits added to the prelude in future editions."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2021,compile_fail"]
#[doc = r" #![deny(rust_2024_prelude_collisions)]"]
#[doc = r" trait Meow {"]
#[doc = r" fn poll(&self) {}"]
#[doc = r" }"]
#[doc = r" impl<T> Meow for T {}"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" core::pin::pin!(async {}).poll();"]
#[doc = r" // ^^^^^^"]
#[doc =
r" // This call to try_into matches both Future::poll and Meow::poll as"]
#[doc =
r" // `Future` has been added to the Rust prelude in 2024 edition."]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Rust 2024, introduces two new additions to the standard library's prelude:"]
#[doc =
r" `Future` and `IntoFuture`. This results in an ambiguity as to which method/function"]
#[doc =
r" to call when an existing `poll`/`into_future` method is called via dot-call syntax or"]
#[doc =
r" a `poll`/`into_future` associated function is called directly on a type."]
#[doc = r""]
pub static RUST_2024_PRELUDE_COLLISIONS: &crate::Lint =
&crate::Lint {
name: "RUST_2024_PRELUDE_COLLISIONS",
default_level: crate::Allow,
desc: "detects the usage of trait methods which are ambiguous with traits added to the \
prelude in future editions",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "prelude",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3582/// The `rust_2024_prelude_collisions` lint detects the usage of trait methods which are ambiguous
3583 /// with traits added to the prelude in future editions.
3584 ///
3585 /// ### Example
3586 ///
3587 /// ```rust,edition2021,compile_fail
3588 /// #![deny(rust_2024_prelude_collisions)]
3589 /// trait Meow {
3590 /// fn poll(&self) {}
3591 /// }
3592 /// impl<T> Meow for T {}
3593 ///
3594 /// fn main() {
3595 /// core::pin::pin!(async {}).poll();
3596 /// // ^^^^^^
3597 /// // This call to try_into matches both Future::poll and Meow::poll as
3598 /// // `Future` has been added to the Rust prelude in 2024 edition.
3599 /// }
3600 /// ```
3601 ///
3602 /// {{produces}}
3603 ///
3604 /// ### Explanation
3605 ///
3606 /// Rust 2024, introduces two new additions to the standard library's prelude:
3607 /// `Future` and `IntoFuture`. This results in an ambiguity as to which method/function
3608 /// to call when an existing `poll`/`into_future` method is called via dot-call syntax or
3609 /// a `poll`/`into_future` associated function is called directly on a type.
3610 ///
3611pub RUST_2024_PRELUDE_COLLISIONS,
3612 Allow,
3613"detects the usage of trait methods which are ambiguous with traits added to the \
3614 prelude in future editions",
3615 @future_incompatible = FutureIncompatibleInfo {
3616 reason: fcw!(EditionError 2024 "prelude"),
3617 };
3618}36193620#[doc =
r" The `rust_2021_prefixes_incompatible_syntax` lint detects identifiers that will be parsed as a"]
#[doc = r" prefix instead in Rust 2021."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2018,compile_fail"]
#[doc = r" #![deny(rust_2021_prefixes_incompatible_syntax)]"]
#[doc = r""]
#[doc = r" macro_rules! m {"]
#[doc = r" (z $x:expr) => ();"]
#[doc = r" }"]
#[doc = r""]
#[doc = r#" m!(z"hey");"#]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r#" In Rust 2015 and 2018, `z"hey"` is two tokens: the identifier `z`"#]
#[doc =
r#" followed by the string literal `"hey"`. In Rust 2021, the `z` is"#]
#[doc = r#" considered a prefix for `"hey"`."#]
#[doc = r""]
#[doc =
r#" This lint suggests to add whitespace between the `z` and `"hey"` tokens"#]
#[doc = r" to keep them separated in Rust 2021."]
#[allow(rustdoc::invalid_rust_codeblocks)]
pub static RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX: &crate::Lint =
&crate::Lint {
name: "RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX",
default_level: crate::Allow,
desc: "identifiers that will be parsed as a prefix in Rust 2021",
is_externally_loaded: false,
crate_level_only: true,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2021,
page_slug: "reserving-syntax",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3621/// The `rust_2021_prefixes_incompatible_syntax` lint detects identifiers that will be parsed as a
3622 /// prefix instead in Rust 2021.
3623 ///
3624 /// ### Example
3625 ///
3626 /// ```rust,edition2018,compile_fail
3627 /// #![deny(rust_2021_prefixes_incompatible_syntax)]
3628 ///
3629 /// macro_rules! m {
3630 /// (z $x:expr) => ();
3631 /// }
3632 ///
3633 /// m!(z"hey");
3634 /// ```
3635 ///
3636 /// {{produces}}
3637 ///
3638 /// ### Explanation
3639 ///
3640 /// In Rust 2015 and 2018, `z"hey"` is two tokens: the identifier `z`
3641 /// followed by the string literal `"hey"`. In Rust 2021, the `z` is
3642 /// considered a prefix for `"hey"`.
3643 ///
3644 /// This lint suggests to add whitespace between the `z` and `"hey"` tokens
3645 /// to keep them separated in Rust 2021.
3646// Allow this lint -- rustdoc doesn't yet support threading edition into this lint's parser.
3647#[allow(rustdoc::invalid_rust_codeblocks)]
3648pub RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
3649 Allow,
3650"identifiers that will be parsed as a prefix in Rust 2021",
3651 @future_incompatible = FutureIncompatibleInfo {
3652 reason: fcw!(EditionError 2021 "reserving-syntax"),
3653 };
3654 crate_level_only
3655}36563657#[doc =
r" The `unsupported_calling_conventions` lint is output whenever there is a use of the"]
#[doc =
r" `stdcall`, `fastcall`, and `cdecl` calling conventions (or their unwind"]
#[doc =
r" variants) on targets that cannot meaningfully be supported for the requested target."]
#[doc = r""]
#[doc =
r" For example, `stdcall` does not make much sense for a x86_64 or, more apparently, powerpc"]
#[doc =
r" code, because this calling convention was never specified for those targets."]
#[doc = r""]
#[doc =
r" Historically, MSVC toolchains have fallen back to the regular C calling convention for"]
#[doc =
r" targets other than x86, but Rust doesn't really see a similar need to introduce a similar"]
#[doc = r" hack across many more targets."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs specific targets)"]
#[doc = r#" extern "stdcall" fn stdcall() {}"#]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: use of calling convention not supported on this target"]
#[doc = r" --> $DIR/unsupported.rs:39:1"]
#[doc = r" |"]
#[doc = r#" LL | extern "stdcall" fn stdcall() {}"#]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc = r" |"]
#[doc =
r" = note: `#[warn(unsupported_calling_conventions)]` on by default"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out;"]
#[doc = r" it will become a hard error in a future release!"]
#[doc = r" = note: for more information, see issue ..."]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" On most of the targets, the behaviour of `stdcall` and similar calling conventions is not"]
#[doc =
r" defined at all, but was previously accepted due to a bug in the implementation of the"]
#[doc = r" compiler."]
pub static UNSUPPORTED_CALLING_CONVENTIONS: &crate::Lint =
&crate::Lint {
name: "UNSUPPORTED_CALLING_CONVENTIONS",
default_level: crate::Warn,
desc: "use of unsupported calling convention",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 137018,
}),
report_in_deps: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3658/// The `unsupported_calling_conventions` lint is output whenever there is a use of the
3659 /// `stdcall`, `fastcall`, and `cdecl` calling conventions (or their unwind
3660 /// variants) on targets that cannot meaningfully be supported for the requested target.
3661 ///
3662 /// For example, `stdcall` does not make much sense for a x86_64 or, more apparently, powerpc
3663 /// code, because this calling convention was never specified for those targets.
3664 ///
3665 /// Historically, MSVC toolchains have fallen back to the regular C calling convention for
3666 /// targets other than x86, but Rust doesn't really see a similar need to introduce a similar
3667 /// hack across many more targets.
3668 ///
3669 /// ### Example
3670 ///
3671 /// ```rust,ignore (needs specific targets)
3672 /// extern "stdcall" fn stdcall() {}
3673 /// ```
3674 ///
3675 /// This will produce:
3676 ///
3677 /// ```text
3678 /// warning: use of calling convention not supported on this target
3679 /// --> $DIR/unsupported.rs:39:1
3680 /// |
3681 /// LL | extern "stdcall" fn stdcall() {}
3682 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3683 /// |
3684 /// = note: `#[warn(unsupported_calling_conventions)]` on by default
3685 /// = warning: this was previously accepted by the compiler but is being phased out;
3686 /// it will become a hard error in a future release!
3687 /// = note: for more information, see issue ...
3688 /// ```
3689 ///
3690 /// ### Explanation
3691 ///
3692 /// On most of the targets, the behaviour of `stdcall` and similar calling conventions is not
3693 /// defined at all, but was previously accepted due to a bug in the implementation of the
3694 /// compiler.
3695pub UNSUPPORTED_CALLING_CONVENTIONS,
3696 Warn,
3697"use of unsupported calling convention",
3698 @future_incompatible = FutureIncompatibleInfo {
3699 reason: fcw!(FutureReleaseError #137018),
3700 report_in_deps: false,
3701 };
3702}37033704#[doc =
r" The `unsupported_fn_ptr_calling_conventions` lint is output whenever there is a use of"]
#[doc =
r" a target dependent calling convention on a target that does not support this calling"]
#[doc = r" convention on a function pointer."]
#[doc = r""]
#[doc =
r" For example `stdcall` does not make much sense for a x86_64 or, more apparently, powerpc"]
#[doc =
r" code, because this calling convention was never specified for those targets."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs specific targets)"]
#[doc = r#" fn stdcall_ptr(f: extern "stdcall" fn ()) {"#]
#[doc = r" f()"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r#" warning: the calling convention `"stdcall"` is not supported on this target"#]
#[doc = r" --> $DIR/unsupported.rs:34:15"]
#[doc = r" |"]
#[doc = r#" LL | fn stdcall_ptr(f: extern "stdcall" fn()) {"#]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc = r" |"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!"]
#[doc =
r" = note: for more information, see issue #130260 <https://github.com/rust-lang/rust/issues/130260>"]
#[doc =
r" = note: `#[warn(unsupported_fn_ptr_calling_conventions)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" On most of the targets the behaviour of `stdcall` and similar calling conventions is not"]
#[doc =
r" defined at all, but was previously accepted due to a bug in the implementation of the"]
#[doc = r" compiler."]
pub static UNSUPPORTED_FN_PTR_CALLING_CONVENTIONS: &crate::Lint =
&crate::Lint {
name: "UNSUPPORTED_FN_PTR_CALLING_CONVENTIONS",
default_level: crate::Warn,
desc: "use of unsupported calling convention for function pointer",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 130260,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3705/// The `unsupported_fn_ptr_calling_conventions` lint is output whenever there is a use of
3706 /// a target dependent calling convention on a target that does not support this calling
3707 /// convention on a function pointer.
3708 ///
3709 /// For example `stdcall` does not make much sense for a x86_64 or, more apparently, powerpc
3710 /// code, because this calling convention was never specified for those targets.
3711 ///
3712 /// ### Example
3713 ///
3714 /// ```rust,ignore (needs specific targets)
3715 /// fn stdcall_ptr(f: extern "stdcall" fn ()) {
3716 /// f()
3717 /// }
3718 /// ```
3719 ///
3720 /// This will produce:
3721 ///
3722 /// ```text
3723 /// warning: the calling convention `"stdcall"` is not supported on this target
3724 /// --> $DIR/unsupported.rs:34:15
3725 /// |
3726 /// LL | fn stdcall_ptr(f: extern "stdcall" fn()) {
3727 /// | ^^^^^^^^^^^^^^^^^^^^^^^^
3728 /// |
3729 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3730 /// = note: for more information, see issue #130260 <https://github.com/rust-lang/rust/issues/130260>
3731 /// = note: `#[warn(unsupported_fn_ptr_calling_conventions)]` on by default
3732 /// ```
3733 ///
3734 /// ### Explanation
3735 ///
3736 /// On most of the targets the behaviour of `stdcall` and similar calling conventions is not
3737 /// defined at all, but was previously accepted due to a bug in the implementation of the
3738 /// compiler.
3739pub UNSUPPORTED_FN_PTR_CALLING_CONVENTIONS,
3740 Warn,
3741"use of unsupported calling convention for function pointer",
3742 @future_incompatible = FutureIncompatibleInfo {
3743 reason: fcw!(FutureReleaseError #130260),
3744 report_in_deps: true,
3745 };
3746}37473748#[doc =
r" The `break_with_label_and_loop` lint detects labeled `break` expressions with"]
#[doc = r" an unlabeled loop as their value expression."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" 'label: loop {"]
#[doc = r" break 'label loop { break 42; };"]
#[doc = r" };"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In Rust, loops can have a label, and `break` expressions can refer to that label to"]
#[doc =
r" break out of specific loops (and not necessarily the innermost one). `break` expressions"]
#[doc =
r" can also carry a value expression, which can be another loop. A labeled `break` with an"]
#[doc =
r" unlabeled loop as its value expression is easy to confuse with an unlabeled break with"]
#[doc =
r" a labeled loop and is thus discouraged (but allowed for compatibility); use parentheses"]
#[doc =
r" around the loop expression to silence this warning. Unlabeled `break` expressions with"]
#[doc =
r" labeled loops yield a hard error, which can also be silenced by wrapping the expression"]
#[doc = r" in parentheses."]
pub static BREAK_WITH_LABEL_AND_LOOP: &crate::Lint =
&crate::Lint {
name: "BREAK_WITH_LABEL_AND_LOOP",
default_level: crate::Warn,
desc: "`break` expression with label and unlabeled loop as value expression",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3749/// The `break_with_label_and_loop` lint detects labeled `break` expressions with
3750 /// an unlabeled loop as their value expression.
3751 ///
3752 /// ### Example
3753 ///
3754 /// ```rust
3755 /// 'label: loop {
3756 /// break 'label loop { break 42; };
3757 /// };
3758 /// ```
3759 ///
3760 /// {{produces}}
3761 ///
3762 /// ### Explanation
3763 ///
3764 /// In Rust, loops can have a label, and `break` expressions can refer to that label to
3765 /// break out of specific loops (and not necessarily the innermost one). `break` expressions
3766 /// can also carry a value expression, which can be another loop. A labeled `break` with an
3767 /// unlabeled loop as its value expression is easy to confuse with an unlabeled break with
3768 /// a labeled loop and is thus discouraged (but allowed for compatibility); use parentheses
3769 /// around the loop expression to silence this warning. Unlabeled `break` expressions with
3770 /// labeled loops yield a hard error, which can also be silenced by wrapping the expression
3771 /// in parentheses.
3772pub BREAK_WITH_LABEL_AND_LOOP,
3773 Warn,
3774"`break` expression with label and unlabeled loop as value expression"
3775}37763777#[doc =
r" The `non_exhaustive_omitted_patterns` lint aims to help consumers of a `#[non_exhaustive]`"]
#[doc =
r" struct or enum who want to match all of its fields/variants explicitly."]
#[doc = r""]
#[doc =
r" The `#[non_exhaustive]` annotation forces matches to use wildcards, so exhaustiveness"]
#[doc =
r" checking cannot be used to ensure that all fields/variants are matched explicitly. To remedy"]
#[doc =
r" this, this allow-by-default lint warns the user when a match mentions some but not all of"]
#[doc = r" the fields/variants of a `#[non_exhaustive]` struct or enum."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs separate crate)"]
#[doc = r" // crate A"]
#[doc = r" #[non_exhaustive]"]
#[doc = r" pub enum Bar {"]
#[doc = r" A,"]
#[doc = r" B, // added variant in non breaking change"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" // in crate B"]
#[doc = r" #![feature(non_exhaustive_omitted_patterns_lint)]"]
#[doc = r" #[warn(non_exhaustive_omitted_patterns)]"]
#[doc = r" match Bar::A {"]
#[doc = r" Bar::A => {},"]
#[doc = r" _ => {},"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: some variants are not matched explicitly"]
#[doc = r" --> $DIR/reachable-patterns.rs:70:9"]
#[doc = r" |"]
#[doc = r" LL | match Bar::A {"]
#[doc = r" | ^ pattern `Bar::B` not covered"]
#[doc = r" |"]
#[doc = r" note: the lint level is defined here"]
#[doc = r" --> $DIR/reachable-patterns.rs:69:16"]
#[doc = r" |"]
#[doc = r" LL | #[warn(non_exhaustive_omitted_patterns)]"]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc =
r" = help: ensure that all variants are matched explicitly by adding the suggested match arms"]
#[doc =
r" = note: the matched value is of type `Bar` and the `non_exhaustive_omitted_patterns` attribute was found"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" Warning: setting this to `deny` will make upstream non-breaking changes (adding fields or"]
#[doc =
r" variants to a `#[non_exhaustive]` struct or enum) break your crate. This goes against"]
#[doc = r" expected semver behavior."]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Structs and enums tagged with `#[non_exhaustive]` force the user to add a (potentially"]
#[doc =
r" redundant) wildcard when pattern-matching, to allow for future addition of fields or"]
#[doc =
r" variants. The `non_exhaustive_omitted_patterns` lint detects when such a wildcard happens to"]
#[doc =
r" actually catch some fields/variants. In other words, when the match without the wildcard"]
#[doc =
r" would not be exhaustive. This lets the user be informed if new fields/variants were added."]
pub static NON_EXHAUSTIVE_OMITTED_PATTERNS: &crate::Lint =
&crate::Lint {
name: "NON_EXHAUSTIVE_OMITTED_PATTERNS",
default_level: crate::Allow,
desc: "detect when patterns of types marked `non_exhaustive` are missed",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::non_exhaustive_omitted_patterns_lint),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3778/// The `non_exhaustive_omitted_patterns` lint aims to help consumers of a `#[non_exhaustive]`
3779 /// struct or enum who want to match all of its fields/variants explicitly.
3780 ///
3781 /// The `#[non_exhaustive]` annotation forces matches to use wildcards, so exhaustiveness
3782 /// checking cannot be used to ensure that all fields/variants are matched explicitly. To remedy
3783 /// this, this allow-by-default lint warns the user when a match mentions some but not all of
3784 /// the fields/variants of a `#[non_exhaustive]` struct or enum.
3785 ///
3786 /// ### Example
3787 ///
3788 /// ```rust,ignore (needs separate crate)
3789 /// // crate A
3790 /// #[non_exhaustive]
3791 /// pub enum Bar {
3792 /// A,
3793 /// B, // added variant in non breaking change
3794 /// }
3795 ///
3796 /// // in crate B
3797 /// #![feature(non_exhaustive_omitted_patterns_lint)]
3798 /// #[warn(non_exhaustive_omitted_patterns)]
3799 /// match Bar::A {
3800 /// Bar::A => {},
3801 /// _ => {},
3802 /// }
3803 /// ```
3804 ///
3805 /// This will produce:
3806 ///
3807 /// ```text
3808 /// warning: some variants are not matched explicitly
3809 /// --> $DIR/reachable-patterns.rs:70:9
3810 /// |
3811 /// LL | match Bar::A {
3812 /// | ^ pattern `Bar::B` not covered
3813 /// |
3814 /// note: the lint level is defined here
3815 /// --> $DIR/reachable-patterns.rs:69:16
3816 /// |
3817 /// LL | #[warn(non_exhaustive_omitted_patterns)]
3818 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3819 /// = help: ensure that all variants are matched explicitly by adding the suggested match arms
3820 /// = note: the matched value is of type `Bar` and the `non_exhaustive_omitted_patterns` attribute was found
3821 /// ```
3822 ///
3823 /// Warning: setting this to `deny` will make upstream non-breaking changes (adding fields or
3824 /// variants to a `#[non_exhaustive]` struct or enum) break your crate. This goes against
3825 /// expected semver behavior.
3826 ///
3827 /// ### Explanation
3828 ///
3829 /// Structs and enums tagged with `#[non_exhaustive]` force the user to add a (potentially
3830 /// redundant) wildcard when pattern-matching, to allow for future addition of fields or
3831 /// variants. The `non_exhaustive_omitted_patterns` lint detects when such a wildcard happens to
3832 /// actually catch some fields/variants. In other words, when the match without the wildcard
3833 /// would not be exhaustive. This lets the user be informed if new fields/variants were added.
3834pub NON_EXHAUSTIVE_OMITTED_PATTERNS,
3835 Allow,
3836"detect when patterns of types marked `non_exhaustive` are missed",
3837 @feature_gate = non_exhaustive_omitted_patterns_lint;
3838}38393840#[doc =
r" The `text_direction_codepoint_in_comment` lint detects Unicode codepoints in comments that"]
#[doc =
r" change the visual representation of text on screen in a way that does not correspond to"]
#[doc = r" their on memory representation."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(text_direction_codepoint_in_comment)]"]
#[doc = r" fn main() {"]
#[doc = " println!(\"{:?}\"); // '\u{202E}');"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Unicode allows changing the visual flow of text on screen in order to support scripts that"]
#[doc =
r" are written right-to-left, but a specially crafted comment can make code that will be"]
#[doc =
r" compiled appear to be part of a comment, depending on the software used to read the code."]
#[doc =
r" To avoid potential problems or confusion, such as in CVE-2021-42574, by default we deny"]
#[doc = r" their use."]
pub static TEXT_DIRECTION_CODEPOINT_IN_COMMENT: &crate::Lint =
&crate::Lint {
name: "TEXT_DIRECTION_CODEPOINT_IN_COMMENT",
default_level: crate::Deny,
desc: "invisible directionality-changing codepoints in comment",
is_externally_loaded: false,
crate_level_only: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3841/// The `text_direction_codepoint_in_comment` lint detects Unicode codepoints in comments that
3842 /// change the visual representation of text on screen in a way that does not correspond to
3843 /// their on memory representation.
3844 ///
3845 /// ### Example
3846 ///
3847 /// ```rust,compile_fail
3848 /// #![deny(text_direction_codepoint_in_comment)]
3849 /// fn main() {
3850#[doc = " println!(\"{:?}\"); // '\u{202E}');"]
3851/// }
3852 /// ```
3853 ///
3854 /// {{produces}}
3855 ///
3856 /// ### Explanation
3857 ///
3858 /// Unicode allows changing the visual flow of text on screen in order to support scripts that
3859 /// are written right-to-left, but a specially crafted comment can make code that will be
3860 /// compiled appear to be part of a comment, depending on the software used to read the code.
3861 /// To avoid potential problems or confusion, such as in CVE-2021-42574, by default we deny
3862 /// their use.
3863pub TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
3864 Deny,
3865"invisible directionality-changing codepoints in comment",
3866 crate_level_only
3867}38683869#[doc =
r" The `text_direction_codepoint_in_literal` lint detects Unicode codepoints that change the"]
#[doc =
r" visual representation of text on screen in a way that does not correspond to their on"]
#[doc = r" memory representation."]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The unicode characters `\u{202A}`, `\u{202B}`, `\u{202D}`, `\u{202E}`, `\u{2066}`,"]
#[doc =
r" `\u{2067}`, `\u{2068}`, `\u{202C}` and `\u{2069}` make the flow of text on screen change"]
#[doc =
r#" its direction on software that supports these codepoints. This makes the text "abc" display"#]
#[doc =
r#" as "cba" on screen. By leveraging software that supports these, people can write specially"#]
#[doc =
r" crafted literals that make the surrounding code seem like it's performing one action, when"]
#[doc =
r" in reality it is performing another. Because of this, we proactively lint against their"]
#[doc = r" presence to avoid surprises."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(text_direction_codepoint_in_literal)]"]
#[doc = r" fn main() {"]
#[doc = " println!(\"{:?}\", '\u{202E}');"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
pub static TEXT_DIRECTION_CODEPOINT_IN_LITERAL: &crate::Lint =
&crate::Lint {
name: "TEXT_DIRECTION_CODEPOINT_IN_LITERAL",
default_level: crate::Deny,
desc: "detect special Unicode codepoints that affect the visual representation of text on screen, \
changing the direction in which text flows",
is_externally_loaded: false,
crate_level_only: true,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3870/// The `text_direction_codepoint_in_literal` lint detects Unicode codepoints that change the
3871 /// visual representation of text on screen in a way that does not correspond to their on
3872 /// memory representation.
3873 ///
3874 /// ### Explanation
3875 ///
3876 /// The unicode characters `\u{202A}`, `\u{202B}`, `\u{202D}`, `\u{202E}`, `\u{2066}`,
3877 /// `\u{2067}`, `\u{2068}`, `\u{202C}` and `\u{2069}` make the flow of text on screen change
3878 /// its direction on software that supports these codepoints. This makes the text "abc" display
3879 /// as "cba" on screen. By leveraging software that supports these, people can write specially
3880 /// crafted literals that make the surrounding code seem like it's performing one action, when
3881 /// in reality it is performing another. Because of this, we proactively lint against their
3882 /// presence to avoid surprises.
3883 ///
3884 /// ### Example
3885 ///
3886 /// ```rust,compile_fail
3887 /// #![deny(text_direction_codepoint_in_literal)]
3888 /// fn main() {
3889// ` - convince tidy that backticks match
3890#[doc = " println!(\"{:?}\", '\u{202E}');"]
3891// `
3892/// }
3893 /// ```
3894 ///
3895 /// {{produces}}
3896 ///
3897pub TEXT_DIRECTION_CODEPOINT_IN_LITERAL,
3898 Deny,
3899"detect special Unicode codepoints that affect the visual representation of text on screen, \
3900 changing the direction in which text flows",
3901 crate_level_only
3902}39033904#[doc =
r" The `duplicate_macro_attributes` lint detects when a `#[test]`-like built-in macro"]
#[doc =
r" attribute is duplicated on an item. This lint may trigger on `bench`, `cfg_eval`, `test`"]
#[doc = r" and `test_case`."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs --test)"]
#[doc = r" #[test]"]
#[doc = r" #[test]"]
#[doc = r" fn foo() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: duplicated attribute"]
#[doc = r" --> src/lib.rs:2:1"]
#[doc = r" |"]
#[doc = r" 2 | #[test]"]
#[doc = r" | ^^^^^^^"]
#[doc = r" |"]
#[doc = r" = note: `#[warn(duplicate_macro_attributes)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" A duplicated attribute may erroneously originate from a copy-paste and the effect of it"]
#[doc = r" being duplicated may not be obvious or desirable."]
#[doc = r""]
#[doc =
r" For instance, doubling the `#[test]` attributes registers the test to be run twice with no"]
#[doc = r" change to its environment."]
#[doc = r""]
#[doc = r" [issue #90979]: https://github.com/rust-lang/rust/issues/90979"]
pub static DUPLICATE_MACRO_ATTRIBUTES: &crate::Lint =
&crate::Lint {
name: "DUPLICATE_MACRO_ATTRIBUTES",
default_level: crate::Warn,
desc: "duplicated attribute",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3905/// The `duplicate_macro_attributes` lint detects when a `#[test]`-like built-in macro
3906 /// attribute is duplicated on an item. This lint may trigger on `bench`, `cfg_eval`, `test`
3907 /// and `test_case`.
3908 ///
3909 /// ### Example
3910 ///
3911 /// ```rust,ignore (needs --test)
3912 /// #[test]
3913 /// #[test]
3914 /// fn foo() {}
3915 /// ```
3916 ///
3917 /// This will produce:
3918 ///
3919 /// ```text
3920 /// warning: duplicated attribute
3921 /// --> src/lib.rs:2:1
3922 /// |
3923 /// 2 | #[test]
3924 /// | ^^^^^^^
3925 /// |
3926 /// = note: `#[warn(duplicate_macro_attributes)]` on by default
3927 /// ```
3928 ///
3929 /// ### Explanation
3930 ///
3931 /// A duplicated attribute may erroneously originate from a copy-paste and the effect of it
3932 /// being duplicated may not be obvious or desirable.
3933 ///
3934 /// For instance, doubling the `#[test]` attributes registers the test to be run twice with no
3935 /// change to its environment.
3936 ///
3937 /// [issue #90979]: https://github.com/rust-lang/rust/issues/90979
3938pub DUPLICATE_MACRO_ATTRIBUTES,
3939 Warn,
3940"duplicated attribute"
3941}39423943#[doc =
r" The `deprecated_where_clause_location` lint detects when a where clause in front of the equals"]
#[doc = r" in an associated type."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" trait Trait {"]
#[doc = r" type Assoc<'a> where Self: 'a;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl Trait for () {"]
#[doc = r" type Assoc<'a> where Self: 'a = ();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" The preferred location for where clauses on associated types"]
#[doc =
r" is after the type. However, for most of generic associated types development,"]
#[doc =
r" it was only accepted before the equals. To provide a transition period and"]
#[doc =
r" further evaluate this change, both are currently accepted. At some point in"]
#[doc =
r" the future, this may be disallowed at an edition boundary; but, that is"]
#[doc = r" undecided currently."]
pub static DEPRECATED_WHERE_CLAUSE_LOCATION: &crate::Lint =
&crate::Lint {
name: "DEPRECATED_WHERE_CLAUSE_LOCATION",
default_level: crate::Warn,
desc: "deprecated where clause location",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3944/// The `deprecated_where_clause_location` lint detects when a where clause in front of the equals
3945 /// in an associated type.
3946 ///
3947 /// ### Example
3948 ///
3949 /// ```rust
3950 /// trait Trait {
3951 /// type Assoc<'a> where Self: 'a;
3952 /// }
3953 ///
3954 /// impl Trait for () {
3955 /// type Assoc<'a> where Self: 'a = ();
3956 /// }
3957 /// ```
3958 ///
3959 /// {{produces}}
3960 ///
3961 /// ### Explanation
3962 ///
3963 /// The preferred location for where clauses on associated types
3964 /// is after the type. However, for most of generic associated types development,
3965 /// it was only accepted before the equals. To provide a transition period and
3966 /// further evaluate this change, both are currently accepted. At some point in
3967 /// the future, this may be disallowed at an edition boundary; but, that is
3968 /// undecided currently.
3969pub DEPRECATED_WHERE_CLAUSE_LOCATION,
3970 Warn,
3971"deprecated where clause location"
3972}39733974#[doc =
r" The `test_unstable_lint` lint tests unstable lints and is perma-unstable."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc =
r" // This lint is intentionally used to test the compiler's behavior"]
#[doc =
r" // when an unstable lint is enabled without the corresponding feature gate."]
#[doc = r" #![allow(test_unstable_lint)]"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In order to test the behavior of unstable lints, a permanently-unstable"]
#[doc =
r" lint is required. This lint can be used to trigger warnings and errors"]
#[doc = r" from the compiler related to unstable lints."]
pub static TEST_UNSTABLE_LINT: &crate::Lint =
&crate::Lint {
name: "TEST_UNSTABLE_LINT",
default_level: crate::Deny,
desc: "this unstable lint is only for testing",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::test_unstable_lint),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3975/// The `test_unstable_lint` lint tests unstable lints and is perma-unstable.
3976 ///
3977 /// ### Example
3978 ///
3979 /// ```rust
3980 /// // This lint is intentionally used to test the compiler's behavior
3981 /// // when an unstable lint is enabled without the corresponding feature gate.
3982 /// #![allow(test_unstable_lint)]
3983 /// ```
3984 ///
3985 /// {{produces}}
3986 ///
3987 /// ### Explanation
3988 ///
3989 /// In order to test the behavior of unstable lints, a permanently-unstable
3990 /// lint is required. This lint can be used to trigger warnings and errors
3991 /// from the compiler related to unstable lints.
3992pub TEST_UNSTABLE_LINT,
3993 Deny,
3994"this unstable lint is only for testing",
3995 @feature_gate = test_unstable_lint;
3996}39973998#[doc =
r" The `ffi_unwind_calls` lint detects calls to foreign functions or function pointers with"]
#[doc = r" `C-unwind` or other FFI-unwind ABIs."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![warn(ffi_unwind_calls)]"]
#[doc = r""]
#[doc = r#" unsafe extern "C-unwind" {"#]
#[doc = r" fn foo();"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn bar() {"]
#[doc = r" unsafe { foo(); }"]
#[doc = r#" let ptr: unsafe extern "C-unwind" fn() = foo;"#]
#[doc = r" unsafe { ptr(); }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" For crates containing such calls, if they are compiled with `-C panic=unwind` then the"]
#[doc =
r" produced library cannot be linked with crates compiled with `-C panic=abort`. For crates"]
#[doc =
r" that desire this ability it is therefore necessary to avoid such calls."]
pub static FFI_UNWIND_CALLS: &crate::Lint =
&crate::Lint {
name: "FFI_UNWIND_CALLS",
default_level: crate::Allow,
desc: "call to foreign functions or function pointers with FFI-unwind ABI",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3999/// The `ffi_unwind_calls` lint detects calls to foreign functions or function pointers with
4000 /// `C-unwind` or other FFI-unwind ABIs.
4001 ///
4002 /// ### Example
4003 ///
4004 /// ```rust
4005 /// #![warn(ffi_unwind_calls)]
4006 ///
4007 /// unsafe extern "C-unwind" {
4008 /// fn foo();
4009 /// }
4010 ///
4011 /// fn bar() {
4012 /// unsafe { foo(); }
4013 /// let ptr: unsafe extern "C-unwind" fn() = foo;
4014 /// unsafe { ptr(); }
4015 /// }
4016 /// ```
4017 ///
4018 /// {{produces}}
4019 ///
4020 /// ### Explanation
4021 ///
4022 /// For crates containing such calls, if they are compiled with `-C panic=unwind` then the
4023 /// produced library cannot be linked with crates compiled with `-C panic=abort`. For crates
4024 /// that desire this ability it is therefore necessary to avoid such calls.
4025pub FFI_UNWIND_CALLS,
4026 Allow,
4027"call to foreign functions or function pointers with FFI-unwind ABI"
4028}40294030#[doc = r" The `linker_messages` lint forwards warnings from the linker."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs CLI args, platform-specific)"]
#[doc = r" #[warn(linker_messages)]"]
#[doc = r#" extern "C" {"#]
#[doc = r" fn foo();"]
#[doc = r" }"]
#[doc = r" fn main () { unsafe { foo(); } }"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" On Linux, using `gcc -Wl,--warn-unresolved-symbols` as a linker, this will produce"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: linker stderr: rust-lld: undefined symbol: foo"]
#[doc = r" >>> referenced by rust_out.69edbd30df4ae57d-cgu.0"]
#[doc =
r" >>> rust_out.rust_out.69edbd30df4ae57d-cgu.0.rcgu.o:(rust_out::main::h3a90094b06757803)"]
#[doc = r" |"]
#[doc = r" note: the lint level is defined here"]
#[doc = r" --> warn.rs:1:9"]
#[doc = r" |"]
#[doc = r" 1 | #![warn(linker_messages)]"]
#[doc = r" | ^^^^^^^^^^^^^^^"]
#[doc = r" warning: 1 warning emitted"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Linkers emit platform-specific and program-specific warnings that cannot be predicted in"]
#[doc =
r" advance by the Rust compiler. Such messages are ignored by default for now. While linker"]
#[doc =
r" warnings could be very useful they have been ignored for many years by essentially all"]
#[doc =
r" users, so we need to do a bit more work than just surfacing their text to produce a clear"]
#[doc =
r" and actionable warning of similar quality to our other diagnostics. See this tracking"]
#[doc =
r" issue for more details: <https://github.com/rust-lang/rust/issues/136096>."]
pub static LINKER_MESSAGES: &crate::Lint =
&crate::Lint {
name: "LINKER_MESSAGES",
default_level: crate::Allow,
desc: "warnings emitted at runtime by the target-specific linker program",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4031/// The `linker_messages` lint forwards warnings from the linker.
4032 ///
4033 /// ### Example
4034 ///
4035 /// ```rust,ignore (needs CLI args, platform-specific)
4036 /// #[warn(linker_messages)]
4037 /// extern "C" {
4038 /// fn foo();
4039 /// }
4040 /// fn main () { unsafe { foo(); } }
4041 /// ```
4042 ///
4043 /// On Linux, using `gcc -Wl,--warn-unresolved-symbols` as a linker, this will produce
4044 ///
4045 /// ```text
4046 /// warning: linker stderr: rust-lld: undefined symbol: foo
4047 /// >>> referenced by rust_out.69edbd30df4ae57d-cgu.0
4048 /// >>> rust_out.rust_out.69edbd30df4ae57d-cgu.0.rcgu.o:(rust_out::main::h3a90094b06757803)
4049 /// |
4050 /// note: the lint level is defined here
4051 /// --> warn.rs:1:9
4052 /// |
4053 /// 1 | #![warn(linker_messages)]
4054 /// | ^^^^^^^^^^^^^^^
4055 /// warning: 1 warning emitted
4056 /// ```
4057 ///
4058 /// ### Explanation
4059 ///
4060 /// Linkers emit platform-specific and program-specific warnings that cannot be predicted in
4061 /// advance by the Rust compiler. Such messages are ignored by default for now. While linker
4062 /// warnings could be very useful they have been ignored for many years by essentially all
4063 /// users, so we need to do a bit more work than just surfacing their text to produce a clear
4064 /// and actionable warning of similar quality to our other diagnostics. See this tracking
4065 /// issue for more details: <https://github.com/rust-lang/rust/issues/136096>.
4066pub LINKER_MESSAGES,
4067 Allow,
4068"warnings emitted at runtime by the target-specific linker program"
4069}40704071#[doc =
r" The `named_arguments_used_positionally` lint detects cases where named arguments are only"]
#[doc =
r" used positionally in format strings. This usage is valid but potentially very confusing."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(named_arguments_used_positionally)]"]
#[doc = r" fn main() {"]
#[doc = r" let _x = 5;"]
#[doc = r#" println!("{}", _x = 1); // Prints 1, will trigger lint"#]
#[doc = r""]
#[doc = r#" println!("{}", _x); // Prints 5, no lint emitted"#]
#[doc = r#" println!("{_x}", _x = _x); // Prints 5, no lint emitted"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Rust formatting strings can refer to named arguments by their position, but this usage is"]
#[doc =
r" potentially confusing. In particular, readers can incorrectly assume that the declaration"]
#[doc =
r" of named arguments is an assignment (which would produce the unit type)."]
#[doc = r" For backwards compatibility, this is not a hard error."]
pub static NAMED_ARGUMENTS_USED_POSITIONALLY: &crate::Lint =
&crate::Lint {
name: "NAMED_ARGUMENTS_USED_POSITIONALLY",
default_level: crate::Warn,
desc: "named arguments in format used positionally",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4072/// The `named_arguments_used_positionally` lint detects cases where named arguments are only
4073 /// used positionally in format strings. This usage is valid but potentially very confusing.
4074 ///
4075 /// ### Example
4076 ///
4077 /// ```rust,compile_fail
4078 /// #![deny(named_arguments_used_positionally)]
4079 /// fn main() {
4080 /// let _x = 5;
4081 /// println!("{}", _x = 1); // Prints 1, will trigger lint
4082 ///
4083 /// println!("{}", _x); // Prints 5, no lint emitted
4084 /// println!("{_x}", _x = _x); // Prints 5, no lint emitted
4085 /// }
4086 /// ```
4087 ///
4088 /// {{produces}}
4089 ///
4090 /// ### Explanation
4091 ///
4092 /// Rust formatting strings can refer to named arguments by their position, but this usage is
4093 /// potentially confusing. In particular, readers can incorrectly assume that the declaration
4094 /// of named arguments is an assignment (which would produce the unit type).
4095 /// For backwards compatibility, this is not a hard error.
4096pub NAMED_ARGUMENTS_USED_POSITIONALLY,
4097 Warn,
4098"named arguments in format used positionally"
4099}41004101#[doc =
r" The `never_type_fallback_flowing_into_unsafe` lint detects cases where never type fallback"]
#[doc = r" affects unsafe function calls."]
#[doc = r""]
#[doc = r" ### Never type fallback"]
#[doc = r""]
#[doc =
r" When the compiler sees a value of type [`!`] it implicitly inserts a coercion (if possible),"]
#[doc = r" to allow type check to infer any type:"]
#[doc = r""]
#[doc = r" ```ignore (illustrative-and-has-placeholders)"]
#[doc = r" // this"]
#[doc = r" let x: u8 = panic!();"]
#[doc = r""]
#[doc = r" // is (essentially) turned by the compiler into"]
#[doc = r" let x: u8 = absurd(panic!());"]
#[doc = r""]
#[doc = r" // where absurd is a function with the following signature"]
#[doc = r" // (it's sound, because `!` always marks unreachable code):"]
#[doc = r" fn absurd<T>(never: !) -> T { ... }"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" While it's convenient to be able to use non-diverging code in one of the branches (like"]
#[doc =
r" `if a { b } else { return }`) this could lead to compilation errors:"]
#[doc = r""]
#[doc = r" ```compile_fail"]
#[doc = r" // this"]
#[doc = r" { panic!() };"]
#[doc = r""]
#[doc = r" // gets turned into this"]
#[doc = r" { absurd(panic!()) }; // error: can't infer the type of `absurd`"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" To prevent such errors, compiler remembers where it inserted `absurd` calls, and if it"]
#[doc =
r" can't infer their type, it sets the type to fallback. `{ absurd::<Fallback>(panic!()) };`."]
#[doc = r#" This is what is known as "never type fallback"."#]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" fn main() {"]
#[doc = r" if true {"]
#[doc =
r" // return has type `!` which, is some cases, causes never type fallback"]
#[doc = r" return"]
#[doc = r" } else {"]
#[doc =
r" // `zeroed` is an unsafe function, which returns an unbounded type"]
#[doc = r" unsafe { std::mem::zeroed() }"]
#[doc = r" };"]
#[doc =
r" // depending on the fallback, `zeroed` may create `()` (which is completely sound),"]
#[doc = r" // or `!` (which is instant undefined behavior)"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Due to historic reasons never type fallback was `()`, meaning that `!` got spontaneously"]
#[doc =
r" coerced to `()`. There are plans to change that, but they may make the code such as above"]
#[doc =
r" unsound. Instead of depending on the fallback, you should specify the type explicitly:"]
#[doc = r" ```"]
#[doc = r" if true {"]
#[doc = r" return"]
#[doc = r" } else {"]
#[doc =
r" // type is explicitly specified, fallback can't hurt us no more"]
#[doc = r" unsafe { std::mem::zeroed::<()>() }"]
#[doc = r" };"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" See [Tracking Issue for making `!` fall back to `!`](https://github.com/rust-lang/rust/issues/123748)."]
#[doc = r""]
#[doc = r" [`!`]: https://doc.rust-lang.org/core/primitive.never.html"]
#[doc = r" [`()`]: https://doc.rust-lang.org/core/primitive.unit.html"]
pub static NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE: &crate::Lint =
&crate::Lint {
name: "NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE",
default_level: crate::Deny,
desc: "never type fallback affecting unsafe function calls",
is_externally_loaded: false,
report_in_external_macro: true,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionAndFutureReleaseSemanticsChange(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "never-type-fallback",
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
edition_lint_opts: Some((crate::Edition::Edition2024,
crate::Deny)),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4102/// The `never_type_fallback_flowing_into_unsafe` lint detects cases where never type fallback
4103 /// affects unsafe function calls.
4104 ///
4105 /// ### Never type fallback
4106 ///
4107 /// When the compiler sees a value of type [`!`] it implicitly inserts a coercion (if possible),
4108 /// to allow type check to infer any type:
4109 ///
4110 /// ```ignore (illustrative-and-has-placeholders)
4111 /// // this
4112 /// let x: u8 = panic!();
4113 ///
4114 /// // is (essentially) turned by the compiler into
4115 /// let x: u8 = absurd(panic!());
4116 ///
4117 /// // where absurd is a function with the following signature
4118 /// // (it's sound, because `!` always marks unreachable code):
4119 /// fn absurd<T>(never: !) -> T { ... }
4120 /// ```
4121 ///
4122 /// While it's convenient to be able to use non-diverging code in one of the branches (like
4123 /// `if a { b } else { return }`) this could lead to compilation errors:
4124 ///
4125 /// ```compile_fail
4126 /// // this
4127 /// { panic!() };
4128 ///
4129 /// // gets turned into this
4130 /// { absurd(panic!()) }; // error: can't infer the type of `absurd`
4131 /// ```
4132 ///
4133 /// To prevent such errors, compiler remembers where it inserted `absurd` calls, and if it
4134 /// can't infer their type, it sets the type to fallback. `{ absurd::<Fallback>(panic!()) };`.
4135 /// This is what is known as "never type fallback".
4136 ///
4137 /// ### Example
4138 ///
4139 /// ```rust,compile_fail
4140 /// fn main() {
4141 /// if true {
4142 /// // return has type `!` which, is some cases, causes never type fallback
4143 /// return
4144 /// } else {
4145 /// // `zeroed` is an unsafe function, which returns an unbounded type
4146 /// unsafe { std::mem::zeroed() }
4147 /// };
4148 /// // depending on the fallback, `zeroed` may create `()` (which is completely sound),
4149 /// // or `!` (which is instant undefined behavior)
4150 /// }
4151 /// ```
4152 ///
4153 /// {{produces}}
4154 ///
4155 /// ### Explanation
4156 ///
4157 /// Due to historic reasons never type fallback was `()`, meaning that `!` got spontaneously
4158 /// coerced to `()`. There are plans to change that, but they may make the code such as above
4159 /// unsound. Instead of depending on the fallback, you should specify the type explicitly:
4160 /// ```
4161 /// if true {
4162 /// return
4163 /// } else {
4164 /// // type is explicitly specified, fallback can't hurt us no more
4165 /// unsafe { std::mem::zeroed::<()>() }
4166 /// };
4167 /// ```
4168 ///
4169 /// See [Tracking Issue for making `!` fall back to `!`](https://github.com/rust-lang/rust/issues/123748).
4170 ///
4171 /// [`!`]: https://doc.rust-lang.org/core/primitive.never.html
4172 /// [`()`]: https://doc.rust-lang.org/core/primitive.unit.html
4173pub NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE,
4174 Deny,
4175"never type fallback affecting unsafe function calls",
4176 @future_incompatible = FutureIncompatibleInfo {
4177 reason: fcw!(EditionAndFutureReleaseSemanticsChange 2024 "never-type-fallback"),
4178 report_in_deps: true,
4179 };
4180 @edition Edition2024 => Deny;
4181 report_in_external_macro
4182}41834184#[doc =
r" The `dependency_on_unit_never_type_fallback` lint detects cases where code compiles with"]
#[doc =
r" [never type fallback] being [`()`], but will stop compiling with fallback being [`!`]."]
#[doc = r""]
#[doc =
r" [never type fallback]: https://doc.rust-lang.org/nightly/core/primitive.never.html#never-type-fallback"]
#[doc = r" [`!`]: https://doc.rust-lang.org/core/primitive.never.html"]
#[doc = r" [`()`]: https://doc.rust-lang.org/core/primitive.unit.html"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail,edition2021"]
#[doc = r" # #![deny(dependency_on_unit_never_type_fallback)]"]
#[doc = r" fn main() {"]
#[doc = r" if true {"]
#[doc =
r" // return has type `!` which, is some cases, causes never type fallback"]
#[doc = r" return"]
#[doc = r" } else {"]
#[doc =
r" // the type produced by this call is not specified explicitly,"]
#[doc = r" // so it will be inferred from the previous branch"]
#[doc = r" Default::default()"]
#[doc = r" };"]
#[doc =
r" // depending on the fallback, this may compile (because `()` implements `Default`),"]
#[doc = r" // or it may not (because `!` does not implement `Default`)"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Due to historic reasons never type fallback was `()`, meaning that `!` got spontaneously"]
#[doc =
r" coerced to `()`. There are plans to change that, but they may make the code such as above"]
#[doc =
r" not compile. Instead of depending on the fallback, you should specify the type explicitly:"]
#[doc = r" ```"]
#[doc = r" if true {"]
#[doc = r" return"]
#[doc = r" } else {"]
#[doc =
r" // type is explicitly specified, fallback can't hurt us no more"]
#[doc = r" <() as Default>::default()"]
#[doc = r" };"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" See [Tracking Issue for making `!` fall back to `!`](https://github.com/rust-lang/rust/issues/123748)."]
pub static DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK: &crate::Lint =
&crate::Lint {
name: "DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK",
default_level: crate::Deny,
desc: "never type fallback affecting unsafe function calls",
is_externally_loaded: false,
report_in_external_macro: true,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionAndFutureReleaseError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "never-type-fallback",
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4185/// The `dependency_on_unit_never_type_fallback` lint detects cases where code compiles with
4186 /// [never type fallback] being [`()`], but will stop compiling with fallback being [`!`].
4187 ///
4188 /// [never type fallback]: https://doc.rust-lang.org/nightly/core/primitive.never.html#never-type-fallback
4189 /// [`!`]: https://doc.rust-lang.org/core/primitive.never.html
4190 /// [`()`]: https://doc.rust-lang.org/core/primitive.unit.html
4191 ///
4192 /// ### Example
4193 ///
4194 /// ```rust,compile_fail,edition2021
4195 /// # #![deny(dependency_on_unit_never_type_fallback)]
4196 /// fn main() {
4197 /// if true {
4198 /// // return has type `!` which, is some cases, causes never type fallback
4199 /// return
4200 /// } else {
4201 /// // the type produced by this call is not specified explicitly,
4202 /// // so it will be inferred from the previous branch
4203 /// Default::default()
4204 /// };
4205 /// // depending on the fallback, this may compile (because `()` implements `Default`),
4206 /// // or it may not (because `!` does not implement `Default`)
4207 /// }
4208 /// ```
4209 ///
4210 /// {{produces}}
4211 ///
4212 /// ### Explanation
4213 ///
4214 /// Due to historic reasons never type fallback was `()`, meaning that `!` got spontaneously
4215 /// coerced to `()`. There are plans to change that, but they may make the code such as above
4216 /// not compile. Instead of depending on the fallback, you should specify the type explicitly:
4217 /// ```
4218 /// if true {
4219 /// return
4220 /// } else {
4221 /// // type is explicitly specified, fallback can't hurt us no more
4222 /// <() as Default>::default()
4223 /// };
4224 /// ```
4225 ///
4226 /// See [Tracking Issue for making `!` fall back to `!`](https://github.com/rust-lang/rust/issues/123748).
4227pub DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK,
4228 Deny,
4229"never type fallback affecting unsafe function calls",
4230 @future_incompatible = FutureIncompatibleInfo {
4231 reason: fcw!(EditionAndFutureReleaseError 2024 "never-type-fallback"),
4232 report_in_deps: true,
4233 };
4234 report_in_external_macro
4235}42364237#[doc =
r" The `invalid_macro_export_arguments` lint detects cases where `#[macro_export]` is being used with invalid arguments."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(invalid_macro_export_arguments)]"]
#[doc = r""]
#[doc = r" #[macro_export(invalid_parameter)]"]
#[doc = r" macro_rules! myMacro {"]
#[doc = r" () => {"]
#[doc = r" // [...]"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" #[macro_export(too, many, items)]"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The only valid argument is `#[macro_export(local_inner_macros)]` or no argument (`#[macro_export]`)."]
#[doc =
r" You can't have multiple arguments in a `#[macro_export(..)]`, or mention arguments other than `local_inner_macros`."]
#[doc = r""]
pub static INVALID_MACRO_EXPORT_ARGUMENTS: &crate::Lint =
&crate::Lint {
name: "INVALID_MACRO_EXPORT_ARGUMENTS",
default_level: crate::Deny,
desc: "\"invalid_parameter\" isn't a valid argument for `#[macro_export]`",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 57571,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4238/// The `invalid_macro_export_arguments` lint detects cases where `#[macro_export]` is being used with invalid arguments.
4239 ///
4240 /// ### Example
4241 ///
4242 /// ```rust,compile_fail
4243 /// #![deny(invalid_macro_export_arguments)]
4244 ///
4245 /// #[macro_export(invalid_parameter)]
4246 /// macro_rules! myMacro {
4247 /// () => {
4248 /// // [...]
4249 /// }
4250 /// }
4251 ///
4252 /// #[macro_export(too, many, items)]
4253 /// ```
4254 ///
4255 /// {{produces}}
4256 ///
4257 /// ### Explanation
4258 ///
4259 /// The only valid argument is `#[macro_export(local_inner_macros)]` or no argument (`#[macro_export]`).
4260 /// You can't have multiple arguments in a `#[macro_export(..)]`, or mention arguments other than `local_inner_macros`.
4261 ///
4262pub INVALID_MACRO_EXPORT_ARGUMENTS,
4263 Deny,
4264"\"invalid_parameter\" isn't a valid argument for `#[macro_export]`",
4265 @future_incompatible = FutureIncompatibleInfo {
4266 reason: fcw!(FutureReleaseError #57571),
4267 report_in_deps: true,
4268 };
4269}42704271#[doc =
r" The `ambiguous_derive_helpers` lint detects cases where a derive macro's helper attribute"]
#[doc = r" is the same name as that of a built-in attribute."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (proc-macro)"]
#[doc = r#" #![crate_type = "proc-macro"]"#]
#[doc = r" #![deny(ambiguous_derive_helpers)]"]
#[doc = r""]
#[doc = r" use proc_macro::TokenStream;"]
#[doc = r""]
#[doc = r" #[proc_macro_derive(Trait, attributes(ignore))]"]
#[doc = r" pub fn example(input: TokenStream) -> TokenStream {"]
#[doc = r" TokenStream::new()"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" Produces:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: there exists a built-in attribute with the same name"]
#[doc = r" --> file.rs:5:39"]
#[doc = r" |"]
#[doc = r" 5 | #[proc_macro_derive(Trait, attributes(ignore))]"]
#[doc = r" | ^^^^^^"]
#[doc = r" |"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!"]
#[doc =
r" = note: for more information, see issue #151152 <https://github.com/rust-lang/rust/issues/151152>"]
#[doc =
r" = note: `#[deny(ambiguous_derive_helpers)]` (part of `#[deny(future_incompatible)]`) on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Attempting to use this helper attribute will throw an error:"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs-dependency)"]
#[doc = r" #[derive(Trait)]"]
#[doc = r" struct Example {"]
#[doc = r" #[ignore]"]
#[doc = r" fields: ()"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" Produces:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" error[E0659]: `ignore` is ambiguous"]
#[doc = r" --> src/lib.rs:5:7"]
#[doc = r" |"]
#[doc = r" 5 | #[ignore]"]
#[doc = r" | ^^^^^^ ambiguous name"]
#[doc = r" |"]
#[doc =
r" = note: ambiguous because of a name conflict with a builtin attribute"]
#[doc = r" = note: `ignore` could refer to a built-in attribute"]
#[doc =
r" note: `ignore` could also refer to the derive helper attribute defined here"]
#[doc = r" --> src/lib.rs:3:10"]
#[doc = r" |"]
#[doc = r" 3 | #[derive(Trait)]"]
#[doc = r" | ^^^^^"]
#[doc = r" ```"]
pub static AMBIGUOUS_DERIVE_HELPERS: &crate::Lint =
&crate::Lint {
name: "AMBIGUOUS_DERIVE_HELPERS",
default_level: crate::Warn,
desc: "detects derive helper attributes that are ambiguous with built-in attributes",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 151276,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4272/// The `ambiguous_derive_helpers` lint detects cases where a derive macro's helper attribute
4273 /// is the same name as that of a built-in attribute.
4274 ///
4275 /// ### Example
4276 ///
4277 /// ```rust,ignore (proc-macro)
4278 /// #![crate_type = "proc-macro"]
4279 /// #![deny(ambiguous_derive_helpers)]
4280 ///
4281 /// use proc_macro::TokenStream;
4282 ///
4283 /// #[proc_macro_derive(Trait, attributes(ignore))]
4284 /// pub fn example(input: TokenStream) -> TokenStream {
4285 /// TokenStream::new()
4286 /// }
4287 /// ```
4288 ///
4289 /// Produces:
4290 ///
4291 /// ```text
4292 /// warning: there exists a built-in attribute with the same name
4293 /// --> file.rs:5:39
4294 /// |
4295 /// 5 | #[proc_macro_derive(Trait, attributes(ignore))]
4296 /// | ^^^^^^
4297 /// |
4298 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
4299 /// = note: for more information, see issue #151152 <https://github.com/rust-lang/rust/issues/151152>
4300 /// = note: `#[deny(ambiguous_derive_helpers)]` (part of `#[deny(future_incompatible)]`) on by default
4301 /// ```
4302 ///
4303 /// ### Explanation
4304 ///
4305 /// Attempting to use this helper attribute will throw an error:
4306 ///
4307 /// ```rust,ignore (needs-dependency)
4308 /// #[derive(Trait)]
4309 /// struct Example {
4310 /// #[ignore]
4311 /// fields: ()
4312 /// }
4313 /// ```
4314 ///
4315 /// Produces:
4316 ///
4317 /// ```text
4318 /// error[E0659]: `ignore` is ambiguous
4319 /// --> src/lib.rs:5:7
4320 /// |
4321 /// 5 | #[ignore]
4322 /// | ^^^^^^ ambiguous name
4323 /// |
4324 /// = note: ambiguous because of a name conflict with a builtin attribute
4325 /// = note: `ignore` could refer to a built-in attribute
4326 /// note: `ignore` could also refer to the derive helper attribute defined here
4327 /// --> src/lib.rs:3:10
4328 /// |
4329 /// 3 | #[derive(Trait)]
4330 /// | ^^^^^
4331 /// ```
4332pub AMBIGUOUS_DERIVE_HELPERS,
4333 Warn,
4334"detects derive helper attributes that are ambiguous with built-in attributes",
4335 @future_incompatible = FutureIncompatibleInfo {
4336 reason: fcw!(FutureReleaseError #151276),
4337 };
4338}43394340#[doc =
r" The `private_interfaces` lint detects types in a primary interface of an item,"]
#[doc =
r" that are more private than the item itself. Primary interface of an item is all"]
#[doc =
r" its interface except for bounds on generic parameters and where clauses."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" # #![allow(unused)]"]
#[doc = r" #![deny(private_interfaces)]"]
#[doc = r" struct SemiPriv;"]
#[doc = r""]
#[doc = r" mod m1 {"]
#[doc = r" struct Priv;"]
#[doc = r" impl crate::SemiPriv {"]
#[doc = r" pub fn f(_: Priv) {}"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" # fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Having something private in primary interface guarantees that"]
#[doc = r" the item will be unusable from outer modules due to type privacy."]
pub static PRIVATE_INTERFACES: &crate::Lint =
&crate::Lint {
name: "PRIVATE_INTERFACES",
default_level: crate::Warn,
desc: "private type in primary interface of an item",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4341/// The `private_interfaces` lint detects types in a primary interface of an item,
4342 /// that are more private than the item itself. Primary interface of an item is all
4343 /// its interface except for bounds on generic parameters and where clauses.
4344 ///
4345 /// ### Example
4346 ///
4347 /// ```rust,compile_fail
4348 /// # #![allow(unused)]
4349 /// #![deny(private_interfaces)]
4350 /// struct SemiPriv;
4351 ///
4352 /// mod m1 {
4353 /// struct Priv;
4354 /// impl crate::SemiPriv {
4355 /// pub fn f(_: Priv) {}
4356 /// }
4357 /// }
4358 ///
4359 /// # fn main() {}
4360 /// ```
4361 ///
4362 /// {{produces}}
4363 ///
4364 /// ### Explanation
4365 ///
4366 /// Having something private in primary interface guarantees that
4367 /// the item will be unusable from outer modules due to type privacy.
4368pub PRIVATE_INTERFACES,
4369 Warn,
4370"private type in primary interface of an item",
4371}43724373#[doc =
r" The `private_bounds` lint detects types in a secondary interface of an item,"]
#[doc =
r" that are more private than the item itself. Secondary interface of an item consists of"]
#[doc =
r" bounds on generic parameters and where clauses, including supertraits for trait items."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" # #![allow(unused)]"]
#[doc = r" #![deny(private_bounds)]"]
#[doc = r""]
#[doc = r" struct PrivTy;"]
#[doc = r" pub struct S"]
#[doc = r" where PrivTy:"]
#[doc = r" {}"]
#[doc = r" # fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Having private types or traits in item bounds makes it less clear what interface"]
#[doc = r" the item actually provides."]
pub static PRIVATE_BOUNDS: &crate::Lint =
&crate::Lint {
name: "PRIVATE_BOUNDS",
default_level: crate::Warn,
desc: "private type in secondary interface of an item",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4374/// The `private_bounds` lint detects types in a secondary interface of an item,
4375 /// that are more private than the item itself. Secondary interface of an item consists of
4376 /// bounds on generic parameters and where clauses, including supertraits for trait items.
4377 ///
4378 /// ### Example
4379 ///
4380 /// ```rust,compile_fail
4381 /// # #![allow(unused)]
4382 /// #![deny(private_bounds)]
4383 ///
4384 /// struct PrivTy;
4385 /// pub struct S
4386 /// where PrivTy:
4387 /// {}
4388 /// # fn main() {}
4389 /// ```
4390 ///
4391 /// {{produces}}
4392 ///
4393 /// ### Explanation
4394 ///
4395 /// Having private types or traits in item bounds makes it less clear what interface
4396 /// the item actually provides.
4397pub PRIVATE_BOUNDS,
4398 Warn,
4399"private type in secondary interface of an item",
4400}44014402#[doc =
r" The `unnameable_types` lint detects types for which you can get objects of that type,"]
#[doc = r" but cannot name the type itself."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" # #![allow(unused)]"]
#[doc = r" #![deny(unnameable_types)]"]
#[doc = r" mod m {"]
#[doc = r" pub struct S;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" pub fn get_unnameable() -> m::S { m::S }"]
#[doc = r" # fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is often expected that if you can obtain an object of type `T`, then"]
#[doc =
r" you can name the type `T` as well; this lint attempts to enforce this rule."]
#[doc =
r" The recommended action is to either reexport the type properly to make it nameable,"]
#[doc =
r" or document that users are not supposed to be able to name it for one reason or another."]
#[doc = r""]
#[doc =
r" Besides types, this lint applies to traits because traits can also leak through signatures,"]
#[doc =
r" and you may obtain objects of their `dyn Trait` or `impl Trait` types."]
pub static UNNAMEABLE_TYPES: &crate::Lint =
&crate::Lint {
name: "UNNAMEABLE_TYPES",
default_level: crate::Allow,
desc: "effective visibility of a type is larger than the area in which it can be named",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4403/// The `unnameable_types` lint detects types for which you can get objects of that type,
4404 /// but cannot name the type itself.
4405 ///
4406 /// ### Example
4407 ///
4408 /// ```rust,compile_fail
4409 /// # #![allow(unused)]
4410 /// #![deny(unnameable_types)]
4411 /// mod m {
4412 /// pub struct S;
4413 /// }
4414 ///
4415 /// pub fn get_unnameable() -> m::S { m::S }
4416 /// # fn main() {}
4417 /// ```
4418 ///
4419 /// {{produces}}
4420 ///
4421 /// ### Explanation
4422 ///
4423 /// It is often expected that if you can obtain an object of type `T`, then
4424 /// you can name the type `T` as well; this lint attempts to enforce this rule.
4425 /// The recommended action is to either reexport the type properly to make it nameable,
4426 /// or document that users are not supposed to be able to name it for one reason or another.
4427 ///
4428 /// Besides types, this lint applies to traits because traits can also leak through signatures,
4429 /// and you may obtain objects of their `dyn Trait` or `impl Trait` types.
4430pub UNNAMEABLE_TYPES,
4431 Allow,
4432"effective visibility of a type is larger than the area in which it can be named",
4433}44344435#[doc =
r" The `malformed_diagnostic_attributes` lint detects malformed diagnostic attributes."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r#" #[diagnostic::do_not_recommend(message = "message")]"#]
#[doc = r" trait Trait {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is usually a mistake to use options or syntax that is not supported. Check the spelling,"]
#[doc =
r" and check the diagnostic attribute listing for the correct name and syntax. Also consider if"]
#[doc =
r" you are using an old version of the compiler; perhaps the option or syntax is only available"]
#[doc =
r" in a newer version. See the [reference] for a list of diagnostic attributes and the syntax"]
#[doc = r" of each."]
#[doc = r""]
#[doc =
r" [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace"]
pub static MALFORMED_DIAGNOSTIC_ATTRIBUTES: &crate::Lint =
&crate::Lint {
name: "MALFORMED_DIAGNOSTIC_ATTRIBUTES",
default_level: crate::Warn,
desc: "detects malformed diagnostic attributes",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4436/// The `malformed_diagnostic_attributes` lint detects malformed diagnostic attributes.
4437 ///
4438 /// ### Example
4439 ///
4440 /// ```rust
4441 /// #[diagnostic::do_not_recommend(message = "message")]
4442 /// trait Trait {}
4443 /// ```
4444 ///
4445 /// {{produces}}
4446 ///
4447 /// ### Explanation
4448 ///
4449 /// It is usually a mistake to use options or syntax that is not supported. Check the spelling,
4450 /// and check the diagnostic attribute listing for the correct name and syntax. Also consider if
4451 /// you are using an old version of the compiler; perhaps the option or syntax is only available
4452 /// in a newer version. See the [reference] for a list of diagnostic attributes and the syntax
4453 /// of each.
4454 ///
4455 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4456pub MALFORMED_DIAGNOSTIC_ATTRIBUTES,
4457 Warn,
4458"detects malformed diagnostic attributes",
4459}44604461#[doc =
r" The `misplaced_diagnostic_attributes` lint detects wrongly placed diagnostic attributes."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #[diagnostic::do_not_recommend]"]
#[doc = r" struct NotUserFacing;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is usually a mistake to specify a diagnostic attribute on an item it is not meant for."]
#[doc =
r" For example, `#[diagnostic::do_not_recommend]` can only be placed on trait implementations,"]
#[doc =
r" and does nothing if placed elsewhere. See the [reference] for a list of diagnostic"]
#[doc = r" attributes and their correct positions."]
#[doc = r""]
#[doc =
r" [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace"]
pub static MISPLACED_DIAGNOSTIC_ATTRIBUTES: &crate::Lint =
&crate::Lint {
name: "MISPLACED_DIAGNOSTIC_ATTRIBUTES",
default_level: crate::Warn,
desc: "detects diagnostic attributes that are placed on the wrong item",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4462/// The `misplaced_diagnostic_attributes` lint detects wrongly placed diagnostic attributes.
4463 ///
4464 /// ### Example
4465 ///
4466 /// ```rust
4467 /// #[diagnostic::do_not_recommend]
4468 /// struct NotUserFacing;
4469 /// ```
4470 ///
4471 /// {{produces}}
4472 ///
4473 /// ### Explanation
4474 ///
4475 /// It is usually a mistake to specify a diagnostic attribute on an item it is not meant for.
4476 /// For example, `#[diagnostic::do_not_recommend]` can only be placed on trait implementations,
4477 /// and does nothing if placed elsewhere. See the [reference] for a list of diagnostic
4478 /// attributes and their correct positions.
4479 ///
4480 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4481pub MISPLACED_DIAGNOSTIC_ATTRIBUTES,
4482 Warn,
4483"detects diagnostic attributes that are placed on the wrong item",
4484}44854486#[doc =
r" The `unknown_diagnostic_attributes` lint detects unknown diagnostic attributes."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #[diagnostic::does_not_exist]"]
#[doc = r" struct Thing;"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" It is usually a mistake to specify a diagnostic attribute that does not exist. Check the"]
#[doc =
r" spelling, and check the diagnostic attribute listing for the correct name. Also consider if"]
#[doc =
r" you are using an old version of the compiler and the attribute is only available in a newer"]
#[doc =
r" version. See the [reference] for the list of diagnostic attributes."]
#[doc = r""]
#[doc =
r" [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace"]
pub static UNKNOWN_DIAGNOSTIC_ATTRIBUTES: &crate::Lint =
&crate::Lint {
name: "UNKNOWN_DIAGNOSTIC_ATTRIBUTES",
default_level: crate::Warn,
desc: "detects unknown diagnostic attributes",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4487/// The `unknown_diagnostic_attributes` lint detects unknown diagnostic attributes.
4488 ///
4489 /// ### Example
4490 ///
4491 /// ```rust
4492 /// #[diagnostic::does_not_exist]
4493 /// struct Thing;
4494 /// ```
4495 ///
4496 /// {{produces}}
4497 ///
4498 /// ### Explanation
4499 ///
4500 /// It is usually a mistake to specify a diagnostic attribute that does not exist. Check the
4501 /// spelling, and check the diagnostic attribute listing for the correct name. Also consider if
4502 /// you are using an old version of the compiler and the attribute is only available in a newer
4503 /// version. See the [reference] for the list of diagnostic attributes.
4504 ///
4505 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4506pub UNKNOWN_DIAGNOSTIC_ATTRIBUTES,
4507 Warn,
4508"detects unknown diagnostic attributes",
4509}45104511#[doc =
r" The `malformed_diagnostic_format_literals` lint detects malformed diagnostic format"]
#[doc = r" literals."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc =
r#" #[diagnostic::on_unimplemented(message = "{Self}} does not implement `Trait`")]"#]
#[doc = r" trait Trait {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The `#[diagnostic::on_unimplemented]` attribute accepts string literal values that are"]
#[doc =
r" similar to `format!`'s string literal. See the [reference] for details on what is permitted"]
#[doc = r" in this string literal."]
#[doc = r""]
#[doc =
r" [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace"]
pub static MALFORMED_DIAGNOSTIC_FORMAT_LITERALS: &crate::Lint =
&crate::Lint {
name: "MALFORMED_DIAGNOSTIC_FORMAT_LITERALS",
default_level: crate::Warn,
desc: "detects diagnostic attribute with malformed diagnostic format literals",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4512/// The `malformed_diagnostic_format_literals` lint detects malformed diagnostic format
4513 /// literals.
4514 ///
4515 /// ### Example
4516 ///
4517 /// ```rust
4518 /// #[diagnostic::on_unimplemented(message = "{Self}} does not implement `Trait`")]
4519 /// trait Trait {}
4520 /// ```
4521 ///
4522 /// {{produces}}
4523 ///
4524 /// ### Explanation
4525 ///
4526 /// The `#[diagnostic::on_unimplemented]` attribute accepts string literal values that are
4527 /// similar to `format!`'s string literal. See the [reference] for details on what is permitted
4528 /// in this string literal.
4529 ///
4530 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4531pub MALFORMED_DIAGNOSTIC_FORMAT_LITERALS,
4532 Warn,
4533"detects diagnostic attribute with malformed diagnostic format literals",
4534}4535#[doc =
r" The `ambiguous_glob_imports` lint detects glob imports that should report ambiguity"]
#[doc = r" errors, but previously didn't do that due to rustc bugs."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(ambiguous_glob_imports)]"]
#[doc = r" pub fn foo() -> u32 {"]
#[doc = r" use sub::*;"]
#[doc = r" C"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" mod sub {"]
#[doc = r" mod mod1 { pub const C: u32 = 1; }"]
#[doc = r" mod mod2 { pub const C: u32 = 2; }"]
#[doc = r""]
#[doc = r" pub use mod1::*;"]
#[doc = r" pub use mod2::*;"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Previous versions of Rust compile it successfully because it"]
#[doc = r" had lost the ambiguity error when resolve `use sub::mod2::*`."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static AMBIGUOUS_GLOB_IMPORTS: &crate::Lint =
&crate::Lint {
name: "AMBIGUOUS_GLOB_IMPORTS",
default_level: crate::Warn,
desc: "detects certain glob imports that require reporting an ambiguity error",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 114095,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4536/// The `ambiguous_glob_imports` lint detects glob imports that should report ambiguity
4537 /// errors, but previously didn't do that due to rustc bugs.
4538 ///
4539 /// ### Example
4540 ///
4541 /// ```rust,compile_fail
4542 /// #![deny(ambiguous_glob_imports)]
4543 /// pub fn foo() -> u32 {
4544 /// use sub::*;
4545 /// C
4546 /// }
4547 ///
4548 /// mod sub {
4549 /// mod mod1 { pub const C: u32 = 1; }
4550 /// mod mod2 { pub const C: u32 = 2; }
4551 ///
4552 /// pub use mod1::*;
4553 /// pub use mod2::*;
4554 /// }
4555 /// ```
4556 ///
4557 /// {{produces}}
4558 ///
4559 /// ### Explanation
4560 ///
4561 /// Previous versions of Rust compile it successfully because it
4562 /// had lost the ambiguity error when resolve `use sub::mod2::*`.
4563 ///
4564 /// This is a [future-incompatible] lint to transition this to a
4565 /// hard error in the future.
4566 ///
4567 /// [future-incompatible]: ../index.md#future-incompatible-lints
4568pub AMBIGUOUS_GLOB_IMPORTS,
4569 Warn,
4570"detects certain glob imports that require reporting an ambiguity error",
4571 @future_incompatible = FutureIncompatibleInfo {
4572 reason: fcw!(FutureReleaseError #114095),
4573 report_in_deps: true,
4574 };
4575}45764577#[doc =
r" The `ambiguous_glob_imported_traits` lint reports uses of traits that are"]
#[doc =
r" imported ambiguously via glob imports. Previously, this was not enforced"]
#[doc = r" due to a bug in rustc."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(ambiguous_glob_imported_traits)]"]
#[doc = r" mod m1 {"]
#[doc = r" pub trait Trait {"]
#[doc = r" fn method1(&self) {}"]
#[doc = r" }"]
#[doc = r" impl Trait for u8 {}"]
#[doc = r" }"]
#[doc = r" mod m2 {"]
#[doc = r" pub trait Trait {"]
#[doc = r" fn method2(&self) {}"]
#[doc = r" }"]
#[doc = r" impl Trait for u8 {}"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" use m1::*;"]
#[doc = r" use m2::*;"]
#[doc = r" 0u8.method1();"]
#[doc = r" 0u8.method2();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" When multiple traits with the same name are brought into scope through glob imports,"]
#[doc =
r#" one trait becomes the "primary" one while the others are shadowed. Methods from the"#]
#[doc =
r#" shadowed traits (e.g. `method2`) become inaccessible, while methods from the "primary""#]
#[doc =
r" trait (e.g. `method1`) still resolve. Ideally, none of the ambiguous traits would be in scope,"]
#[doc =
r" but we have to allow this for now because of backwards compatibility."]
#[doc =
r#" This lint reports uses of these "primary" traits that are ambiguous."#]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static AMBIGUOUS_GLOB_IMPORTED_TRAITS: &crate::Lint =
&crate::Lint {
name: "AMBIGUOUS_GLOB_IMPORTED_TRAITS",
default_level: crate::Warn,
desc: "detects uses of ambiguously glob imported traits",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 147992,
}),
report_in_deps: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4578/// The `ambiguous_glob_imported_traits` lint reports uses of traits that are
4579 /// imported ambiguously via glob imports. Previously, this was not enforced
4580 /// due to a bug in rustc.
4581 ///
4582 /// ### Example
4583 ///
4584 /// ```rust,compile_fail
4585 /// #![deny(ambiguous_glob_imported_traits)]
4586 /// mod m1 {
4587 /// pub trait Trait {
4588 /// fn method1(&self) {}
4589 /// }
4590 /// impl Trait for u8 {}
4591 /// }
4592 /// mod m2 {
4593 /// pub trait Trait {
4594 /// fn method2(&self) {}
4595 /// }
4596 /// impl Trait for u8 {}
4597 /// }
4598 ///
4599 /// fn main() {
4600 /// use m1::*;
4601 /// use m2::*;
4602 /// 0u8.method1();
4603 /// 0u8.method2();
4604 /// }
4605 /// ```
4606 ///
4607 /// {{produces}}
4608 ///
4609 /// ### Explanation
4610 ///
4611 /// When multiple traits with the same name are brought into scope through glob imports,
4612 /// one trait becomes the "primary" one while the others are shadowed. Methods from the
4613 /// shadowed traits (e.g. `method2`) become inaccessible, while methods from the "primary"
4614 /// trait (e.g. `method1`) still resolve. Ideally, none of the ambiguous traits would be in scope,
4615 /// but we have to allow this for now because of backwards compatibility.
4616 /// This lint reports uses of these "primary" traits that are ambiguous.
4617 ///
4618 /// This is a [future-incompatible] lint to transition this to a
4619 /// hard error in the future.
4620 ///
4621 /// [future-incompatible]: ../index.md#future-incompatible-lints
4622pub AMBIGUOUS_GLOB_IMPORTED_TRAITS,
4623 Warn,
4624"detects uses of ambiguously glob imported traits",
4625 @future_incompatible = FutureIncompatibleInfo {
4626 reason: fcw!(FutureReleaseError #147992),
4627 report_in_deps: false,
4628 };
4629}46304631#[doc =
r" The `ambiguous_panic_imports` lint detects ambiguous core and std panic imports, but"]
#[doc =
r" previously didn't do that due to `#[macro_use]` prelude macro import."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(ambiguous_panic_imports)]"]
#[doc = r" #![no_std]"]
#[doc = r""]
#[doc = r" extern crate std;"]
#[doc = r" use std::prelude::v1::*;"]
#[doc = r""]
#[doc = r" fn xx() {"]
#[doc = r" panic!(); // resolves to core::panic"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Future versions of Rust will no longer accept the ambiguous resolution."]
#[doc = r""]
#[doc =
r" This is a [future-incompatible] lint to transition this to a hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static AMBIGUOUS_PANIC_IMPORTS: &crate::Lint =
&crate::Lint {
name: "AMBIGUOUS_PANIC_IMPORTS",
default_level: crate::Warn,
desc: "detects ambiguous core and std panic imports",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 147319,
}),
report_in_deps: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4632/// The `ambiguous_panic_imports` lint detects ambiguous core and std panic imports, but
4633 /// previously didn't do that due to `#[macro_use]` prelude macro import.
4634 ///
4635 /// ### Example
4636 ///
4637 /// ```rust,compile_fail
4638 /// #![deny(ambiguous_panic_imports)]
4639 /// #![no_std]
4640 ///
4641 /// extern crate std;
4642 /// use std::prelude::v1::*;
4643 ///
4644 /// fn xx() {
4645 /// panic!(); // resolves to core::panic
4646 /// }
4647 /// ```
4648 ///
4649 /// {{produces}}
4650 ///
4651 /// ### Explanation
4652 ///
4653 /// Future versions of Rust will no longer accept the ambiguous resolution.
4654 ///
4655 /// This is a [future-incompatible] lint to transition this to a hard error in the future.
4656 ///
4657 /// [future-incompatible]: ../index.md#future-incompatible-lints
4658pub AMBIGUOUS_PANIC_IMPORTS,
4659 Warn,
4660"detects ambiguous core and std panic imports",
4661 @future_incompatible = FutureIncompatibleInfo {
4662 reason: fcw!(FutureReleaseError #147319),
4663 report_in_deps: false,
4664 };
4665}46664667#[doc =
r" The `ambiguous_import_visibilities` lint detects imports that should report ambiguity"]
#[doc = r" errors, but previously didn't do that due to rustc bugs."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(unknown_lints)]"]
#[doc = r" #![deny(ambiguous_import_visibilities)]"]
#[doc = r" mod reexport {"]
#[doc = r" mod m {"]
#[doc = r" pub struct S {}"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" macro_rules! mac {"]
#[doc = r" () => { use m::S; }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" pub use m::*;"]
#[doc = r" mac!();"]
#[doc = r""]
#[doc = r" pub use S as Z; // ambiguous visibility"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" reexport::Z {};"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Previous versions of Rust compile it successfully because it"]
#[doc =
r" fetched the glob import's visibility for `pub use S as Z` import, and ignored the private"]
#[doc = r" `use m::S` import that appeared later."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static AMBIGUOUS_IMPORT_VISIBILITIES: &crate::Lint =
&crate::Lint {
name: "AMBIGUOUS_IMPORT_VISIBILITIES",
default_level: crate::Warn,
desc: "detects certain glob imports that require reporting an ambiguity error",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 149145,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4668/// The `ambiguous_import_visibilities` lint detects imports that should report ambiguity
4669 /// errors, but previously didn't do that due to rustc bugs.
4670 ///
4671 /// ### Example
4672 ///
4673 /// ```rust,compile_fail
4674 /// #![deny(unknown_lints)]
4675 /// #![deny(ambiguous_import_visibilities)]
4676 /// mod reexport {
4677 /// mod m {
4678 /// pub struct S {}
4679 /// }
4680 ///
4681 /// macro_rules! mac {
4682 /// () => { use m::S; }
4683 /// }
4684 ///
4685 /// pub use m::*;
4686 /// mac!();
4687 ///
4688 /// pub use S as Z; // ambiguous visibility
4689 /// }
4690 ///
4691 /// fn main() {
4692 /// reexport::Z {};
4693 /// }
4694 /// ```
4695 ///
4696 /// {{produces}}
4697 ///
4698 /// ### Explanation
4699 ///
4700 /// Previous versions of Rust compile it successfully because it
4701 /// fetched the glob import's visibility for `pub use S as Z` import, and ignored the private
4702 /// `use m::S` import that appeared later.
4703 ///
4704 /// This is a [future-incompatible] lint to transition this to a
4705 /// hard error in the future.
4706 ///
4707 /// [future-incompatible]: ../index.md#future-incompatible-lints
4708pub AMBIGUOUS_IMPORT_VISIBILITIES,
4709 Warn,
4710"detects certain glob imports that require reporting an ambiguity error",
4711 @future_incompatible = FutureIncompatibleInfo {
4712 reason: fcw!(FutureReleaseError #149145),
4713 };
4714}47154716#[doc =
r" The `refining_impl_trait_reachable` lint detects `impl Trait` return"]
#[doc =
r" types in method signatures that are refined by a publically reachable"]
#[doc =
r" trait implementation, meaning the implementation adds information about"]
#[doc = r" the return type that is not present in the trait."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(refining_impl_trait)]"]
#[doc = r""]
#[doc = r" use std::fmt::Display;"]
#[doc = r""]
#[doc = r" pub trait AsDisplay {"]
#[doc = r" fn as_display(&self) -> impl Display;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl<'s> AsDisplay for &'s str {"]
#[doc = r" fn as_display(&self) -> Self {"]
#[doc = r" *self"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" // users can observe that the return type of"]
#[doc = r" // `<&str as AsDisplay>::as_display()` is `&str`."]
#[doc = r#" let _x: &str = "".as_display();"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Callers of methods for types where the implementation is known are"]
#[doc =
r" able to observe the types written in the impl signature. This may be"]
#[doc =
r" intended behavior, but may also lead to implementation details being"]
#[doc =
r" revealed unintentionally. In particular, it may pose a semver hazard"]
#[doc =
r" for authors of libraries who do not wish to make stronger guarantees"]
#[doc = r" about the types than what is written in the trait signature."]
#[doc = r""]
#[doc = r" `refining_impl_trait` is a lint group composed of two lints:"]
#[doc = r""]
#[doc =
r" * `refining_impl_trait_reachable`, for refinements that are publically"]
#[doc = r" reachable outside a crate, and"]
#[doc =
r" * `refining_impl_trait_internal`, for refinements that are only visible"]
#[doc = r" within a crate."]
#[doc = r""]
#[doc = r" We are seeking feedback on each of these lints; see issue"]
#[doc =
r" [#121718](https://github.com/rust-lang/rust/issues/121718) for more"]
#[doc = r" information."]
pub static REFINING_IMPL_TRAIT_REACHABLE: &crate::Lint =
&crate::Lint {
name: "REFINING_IMPL_TRAIT_REACHABLE",
default_level: crate::Warn,
desc: "impl trait in impl method signature does not match trait method signature",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4717/// The `refining_impl_trait_reachable` lint detects `impl Trait` return
4718 /// types in method signatures that are refined by a publically reachable
4719 /// trait implementation, meaning the implementation adds information about
4720 /// the return type that is not present in the trait.
4721 ///
4722 /// ### Example
4723 ///
4724 /// ```rust,compile_fail
4725 /// #![deny(refining_impl_trait)]
4726 ///
4727 /// use std::fmt::Display;
4728 ///
4729 /// pub trait AsDisplay {
4730 /// fn as_display(&self) -> impl Display;
4731 /// }
4732 ///
4733 /// impl<'s> AsDisplay for &'s str {
4734 /// fn as_display(&self) -> Self {
4735 /// *self
4736 /// }
4737 /// }
4738 ///
4739 /// fn main() {
4740 /// // users can observe that the return type of
4741 /// // `<&str as AsDisplay>::as_display()` is `&str`.
4742 /// let _x: &str = "".as_display();
4743 /// }
4744 /// ```
4745 ///
4746 /// {{produces}}
4747 ///
4748 /// ### Explanation
4749 ///
4750 /// Callers of methods for types where the implementation is known are
4751 /// able to observe the types written in the impl signature. This may be
4752 /// intended behavior, but may also lead to implementation details being
4753 /// revealed unintentionally. In particular, it may pose a semver hazard
4754 /// for authors of libraries who do not wish to make stronger guarantees
4755 /// about the types than what is written in the trait signature.
4756 ///
4757 /// `refining_impl_trait` is a lint group composed of two lints:
4758 ///
4759 /// * `refining_impl_trait_reachable`, for refinements that are publically
4760 /// reachable outside a crate, and
4761 /// * `refining_impl_trait_internal`, for refinements that are only visible
4762 /// within a crate.
4763 ///
4764 /// We are seeking feedback on each of these lints; see issue
4765 /// [#121718](https://github.com/rust-lang/rust/issues/121718) for more
4766 /// information.
4767pub REFINING_IMPL_TRAIT_REACHABLE,
4768 Warn,
4769"impl trait in impl method signature does not match trait method signature",
4770}47714772#[doc =
r" The `refining_impl_trait_internal` lint detects `impl Trait` return"]
#[doc =
r" types in method signatures that are refined by a trait implementation,"]
#[doc =
r" meaning the implementation adds information about the return type that"]
#[doc = r" is not present in the trait."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(refining_impl_trait)]"]
#[doc = r""]
#[doc = r" use std::fmt::Display;"]
#[doc = r""]
#[doc = r" trait AsDisplay {"]
#[doc = r" fn as_display(&self) -> impl Display;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl<'s> AsDisplay for &'s str {"]
#[doc = r" fn as_display(&self) -> Self {"]
#[doc = r" *self"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" // users can observe that the return type of"]
#[doc = r" // `<&str as AsDisplay>::as_display()` is `&str`."]
#[doc = r#" let _x: &str = "".as_display();"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Callers of methods for types where the implementation is known are"]
#[doc =
r" able to observe the types written in the impl signature. This may be"]
#[doc =
r" intended behavior, but may also lead to implementation details being"]
#[doc =
r" revealed unintentionally. In particular, it may pose a semver hazard"]
#[doc =
r" for authors of libraries who do not wish to make stronger guarantees"]
#[doc = r" about the types than what is written in the trait signature."]
#[doc = r""]
#[doc = r" `refining_impl_trait` is a lint group composed of two lints:"]
#[doc = r""]
#[doc =
r" * `refining_impl_trait_reachable`, for refinements that are publically"]
#[doc = r" reachable outside a crate, and"]
#[doc =
r" * `refining_impl_trait_internal`, for refinements that are only visible"]
#[doc = r" within a crate."]
#[doc = r""]
#[doc = r" We are seeking feedback on each of these lints; see issue"]
#[doc =
r" [#121718](https://github.com/rust-lang/rust/issues/121718) for more"]
#[doc = r" information."]
pub static REFINING_IMPL_TRAIT_INTERNAL: &crate::Lint =
&crate::Lint {
name: "REFINING_IMPL_TRAIT_INTERNAL",
default_level: crate::Warn,
desc: "impl trait in impl method signature does not match trait method signature",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4773/// The `refining_impl_trait_internal` lint detects `impl Trait` return
4774 /// types in method signatures that are refined by a trait implementation,
4775 /// meaning the implementation adds information about the return type that
4776 /// is not present in the trait.
4777 ///
4778 /// ### Example
4779 ///
4780 /// ```rust,compile_fail
4781 /// #![deny(refining_impl_trait)]
4782 ///
4783 /// use std::fmt::Display;
4784 ///
4785 /// trait AsDisplay {
4786 /// fn as_display(&self) -> impl Display;
4787 /// }
4788 ///
4789 /// impl<'s> AsDisplay for &'s str {
4790 /// fn as_display(&self) -> Self {
4791 /// *self
4792 /// }
4793 /// }
4794 ///
4795 /// fn main() {
4796 /// // users can observe that the return type of
4797 /// // `<&str as AsDisplay>::as_display()` is `&str`.
4798 /// let _x: &str = "".as_display();
4799 /// }
4800 /// ```
4801 ///
4802 /// {{produces}}
4803 ///
4804 /// ### Explanation
4805 ///
4806 /// Callers of methods for types where the implementation is known are
4807 /// able to observe the types written in the impl signature. This may be
4808 /// intended behavior, but may also lead to implementation details being
4809 /// revealed unintentionally. In particular, it may pose a semver hazard
4810 /// for authors of libraries who do not wish to make stronger guarantees
4811 /// about the types than what is written in the trait signature.
4812 ///
4813 /// `refining_impl_trait` is a lint group composed of two lints:
4814 ///
4815 /// * `refining_impl_trait_reachable`, for refinements that are publically
4816 /// reachable outside a crate, and
4817 /// * `refining_impl_trait_internal`, for refinements that are only visible
4818 /// within a crate.
4819 ///
4820 /// We are seeking feedback on each of these lints; see issue
4821 /// [#121718](https://github.com/rust-lang/rust/issues/121718) for more
4822 /// information.
4823pub REFINING_IMPL_TRAIT_INTERNAL,
4824 Warn,
4825"impl trait in impl method signature does not match trait method signature",
4826}48274828#[doc =
r" The `elided_lifetimes_in_associated_constant` lint detects elided lifetimes"]
#[doc =
r" in associated constants when there are other lifetimes in scope. This was"]
#[doc =
r" accidentally supported, and this lint was later relaxed to allow eliding"]
#[doc = r" lifetimes to `'static` when there are no lifetimes in scope."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![deny(elided_lifetimes_in_associated_constant)]"]
#[doc = r""]
#[doc = r" struct Foo<'a>(&'a ());"]
#[doc = r""]
#[doc = r" impl<'a> Foo<'a> {"]
#[doc = r#" const STR: &str = "hello, world";"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Previous version of Rust"]
#[doc = r""]
#[doc =
r" Implicit static-in-const behavior was decided [against] for associated"]
#[doc =
r" constants because of ambiguity. This, however, regressed and the compiler"]
#[doc =
r" erroneously treats elided lifetimes in associated constants as lifetime"]
#[doc = r" parameters on the impl."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future."]
#[doc = r""]
#[doc = r" [against]: https://github.com/rust-lang/rust/issues/38831"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT: &crate::Lint =
&crate::Lint {
name: "ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT",
default_level: crate::Deny,
desc: "elided lifetimes cannot be used in associated constants in impls",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 115010,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4829/// The `elided_lifetimes_in_associated_constant` lint detects elided lifetimes
4830 /// in associated constants when there are other lifetimes in scope. This was
4831 /// accidentally supported, and this lint was later relaxed to allow eliding
4832 /// lifetimes to `'static` when there are no lifetimes in scope.
4833 ///
4834 /// ### Example
4835 ///
4836 /// ```rust,compile_fail
4837 /// #![deny(elided_lifetimes_in_associated_constant)]
4838 ///
4839 /// struct Foo<'a>(&'a ());
4840 ///
4841 /// impl<'a> Foo<'a> {
4842 /// const STR: &str = "hello, world";
4843 /// }
4844 /// ```
4845 ///
4846 /// {{produces}}
4847 ///
4848 /// ### Explanation
4849 ///
4850 /// Previous version of Rust
4851 ///
4852 /// Implicit static-in-const behavior was decided [against] for associated
4853 /// constants because of ambiguity. This, however, regressed and the compiler
4854 /// erroneously treats elided lifetimes in associated constants as lifetime
4855 /// parameters on the impl.
4856 ///
4857 /// This is a [future-incompatible] lint to transition this to a
4858 /// hard error in the future.
4859 ///
4860 /// [against]: https://github.com/rust-lang/rust/issues/38831
4861 /// [future-incompatible]: ../index.md#future-incompatible-lints
4862pub ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
4863 Deny,
4864"elided lifetimes cannot be used in associated constants in impls",
4865 @future_incompatible = FutureIncompatibleInfo {
4866 reason: fcw!(FutureReleaseError #115010),
4867 };
4868}48694870#[doc =
r" The `private_macro_use` lint detects private macros that are imported"]
#[doc = r" with `#[macro_use]`."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs extern crate)"]
#[doc = r" // extern_macro.rs"]
#[doc = r" macro_rules! foo_ { () => {}; }"]
#[doc = r" use foo_ as foo;"]
#[doc = r""]
#[doc = r" // code.rs"]
#[doc = r""]
#[doc = r" #![deny(private_macro_use)]"]
#[doc = r""]
#[doc = r" #[macro_use]"]
#[doc = r" extern crate extern_macro;"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" foo!();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" error: cannot find macro `foo` in this scope"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" This lint arises from overlooking visibility checks for macros"]
#[doc = r" in an external crate."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static PRIVATE_MACRO_USE: &crate::Lint =
&crate::Lint {
name: "PRIVATE_MACRO_USE",
default_level: crate::Deny,
desc: "detects certain macro bindings that should not be re-exported",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 120192,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4871/// The `private_macro_use` lint detects private macros that are imported
4872 /// with `#[macro_use]`.
4873 ///
4874 /// ### Example
4875 ///
4876 /// ```rust,ignore (needs extern crate)
4877 /// // extern_macro.rs
4878 /// macro_rules! foo_ { () => {}; }
4879 /// use foo_ as foo;
4880 ///
4881 /// // code.rs
4882 ///
4883 /// #![deny(private_macro_use)]
4884 ///
4885 /// #[macro_use]
4886 /// extern crate extern_macro;
4887 ///
4888 /// fn main() {
4889 /// foo!();
4890 /// }
4891 /// ```
4892 ///
4893 /// This will produce:
4894 ///
4895 /// ```text
4896 /// error: cannot find macro `foo` in this scope
4897 /// ```
4898 ///
4899 /// ### Explanation
4900 ///
4901 /// This lint arises from overlooking visibility checks for macros
4902 /// in an external crate.
4903 ///
4904 /// This is a [future-incompatible] lint to transition this to a
4905 /// hard error in the future.
4906 ///
4907 /// [future-incompatible]: ../index.md#future-incompatible-lints
4908pub PRIVATE_MACRO_USE,
4909 Deny,
4910"detects certain macro bindings that should not be re-exported",
4911 @future_incompatible = FutureIncompatibleInfo {
4912 reason: fcw!(FutureReleaseError #120192),
4913 report_in_deps: true,
4914 };
4915}49164917#[doc =
r" The `uncovered_param_in_projection` lint detects a violation of one of Rust's orphan rules for"]
#[doc =
r" foreign trait implementations that concerns the use of type parameters inside trait associated"]
#[doc =
r#" type paths ("projections") whose output may not be a local type that is mistakenly considered"#]
#[doc =
r#" to "cover" said parameters which is **unsound** and which may be rejected by a future version"#]
#[doc = r" of the compiler."]
#[doc = r""]
#[doc = r" Originally reported in [#99554]."]
#[doc = r""]
#[doc = r" [#99554]: https://github.com/rust-lang/rust/issues/99554"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (dependent)"]
#[doc = r" // dependency.rs"]
#[doc = r#" #![crate_type = "lib"]"#]
#[doc = r""]
#[doc = r" pub trait Trait<T, U> {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ```edition2021,ignore (needs dependency)"]
#[doc = r" // dependent.rs"]
#[doc = r" trait Identity {"]
#[doc = r" type Output;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" impl<T> Identity for T {"]
#[doc = r" type Output = T;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" struct Local;"]
#[doc = r""]
#[doc =
r" impl<T> dependency::Trait<Local, T> for <T as Identity>::Output {}"]
#[doc = r""]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" warning[E0210]: type parameter `T` must be covered by another type when it appears before the first local type (`Local`)"]
#[doc = r" --> dependent.rs:11:6"]
#[doc = r" |"]
#[doc =
r" 11 | impl<T> dependency::Trait<Local, T> for <T as Identity>::Output {}"]
#[doc =
r" | ^ type parameter `T` must be covered by another type when it appears before the first local type (`Local`)"]
#[doc = r" |"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!"]
#[doc =
r" = note: for more information, see issue #124559 <https://github.com/rust-lang/rust/issues/124559>"]
#[doc =
r" = note: implementing a foreign trait is only possible if at least one of the types for which it is implemented is local, and no uncovered type parameters appear before that first local type"]
#[doc =
r" = note: in this case, 'before' refers to the following order: `impl<..> ForeignTrait<T1, ..., Tn> for T0`, where `T0` is the first and `Tn` is the last"]
#[doc = r" = note: `#[warn(uncovered_param_in_projection)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" FIXME(fmease): Write explainer."]
pub static UNCOVERED_PARAM_IN_PROJECTION: &crate::Lint =
&crate::Lint {
name: "UNCOVERED_PARAM_IN_PROJECTION",
default_level: crate::Warn,
desc: "impl contains type parameters that are not covered",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 124559,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4918/// The `uncovered_param_in_projection` lint detects a violation of one of Rust's orphan rules for
4919 /// foreign trait implementations that concerns the use of type parameters inside trait associated
4920 /// type paths ("projections") whose output may not be a local type that is mistakenly considered
4921 /// to "cover" said parameters which is **unsound** and which may be rejected by a future version
4922 /// of the compiler.
4923 ///
4924 /// Originally reported in [#99554].
4925 ///
4926 /// [#99554]: https://github.com/rust-lang/rust/issues/99554
4927 ///
4928 /// ### Example
4929 ///
4930 /// ```rust,ignore (dependent)
4931 /// // dependency.rs
4932 /// #![crate_type = "lib"]
4933 ///
4934 /// pub trait Trait<T, U> {}
4935 /// ```
4936 ///
4937 /// ```edition2021,ignore (needs dependency)
4938 /// // dependent.rs
4939 /// trait Identity {
4940 /// type Output;
4941 /// }
4942 ///
4943 /// impl<T> Identity for T {
4944 /// type Output = T;
4945 /// }
4946 ///
4947 /// struct Local;
4948 ///
4949 /// impl<T> dependency::Trait<Local, T> for <T as Identity>::Output {}
4950 ///
4951 /// fn main() {}
4952 /// ```
4953 ///
4954 /// This will produce:
4955 ///
4956 /// ```text
4957 /// warning[E0210]: type parameter `T` must be covered by another type when it appears before the first local type (`Local`)
4958 /// --> dependent.rs:11:6
4959 /// |
4960 /// 11 | impl<T> dependency::Trait<Local, T> for <T as Identity>::Output {}
4961 /// | ^ type parameter `T` must be covered by another type when it appears before the first local type (`Local`)
4962 /// |
4963 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
4964 /// = note: for more information, see issue #124559 <https://github.com/rust-lang/rust/issues/124559>
4965 /// = note: implementing a foreign trait is only possible if at least one of the types for which it is implemented is local, and no uncovered type parameters appear before that first local type
4966 /// = note: in this case, 'before' refers to the following order: `impl<..> ForeignTrait<T1, ..., Tn> for T0`, where `T0` is the first and `Tn` is the last
4967 /// = note: `#[warn(uncovered_param_in_projection)]` on by default
4968 /// ```
4969 ///
4970 /// ### Explanation
4971 ///
4972 /// FIXME(fmease): Write explainer.
4973pub UNCOVERED_PARAM_IN_PROJECTION,
4974 Warn,
4975"impl contains type parameters that are not covered",
4976 @future_incompatible = FutureIncompatibleInfo {
4977 reason: fcw!(FutureReleaseError #124559),
4978 };
4979}49804981#[doc =
r" The `deprecated_safe_2024` lint detects unsafe functions being used as"]
#[doc = r" safe functions."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2021,compile_fail"]
#[doc = r" #![deny(deprecated_safe)]"]
#[doc = r" // edition 2021"]
#[doc = r" use std::env;"]
#[doc = r" fn enable_backtrace() {"]
#[doc = r#" env::set_var("RUST_BACKTRACE", "1");"#]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Rust [editions] allow the language to evolve without breaking backward"]
#[doc =
r" compatibility. This lint catches code that uses `unsafe` functions that"]
#[doc =
r" were declared as safe (non-`unsafe`) in editions prior to Rust 2024. If"]
#[doc =
r" you switch the compiler to Rust 2024 without updating the code, then it"]
#[doc =
r" will fail to compile if you are using a function previously marked as"]
#[doc = r" safe."]
#[doc = r""]
#[doc =
r" You can audit the code to see if it suffices the preconditions of the"]
#[doc =
r" `unsafe` code, and if it does, you can wrap it in an `unsafe` block. If"]
#[doc =
r" you can't fulfill the preconditions, you probably need to switch to a"]
#[doc = r" different way of doing what you want to achieve."]
#[doc = r""]
#[doc =
r" This lint can automatically wrap the calls in `unsafe` blocks, but this"]
#[doc = r" obviously cannot verify that the preconditions of the `unsafe`"]
#[doc = r" functions are fulfilled, so that is still up to the user."]
#[doc = r""]
#[doc =
r#" The lint is currently "allow" by default, but that might change in the"#]
#[doc = r" future."]
#[doc = r""]
#[doc = r" [editions]: https://doc.rust-lang.org/edition-guide/"]
pub static DEPRECATED_SAFE_2024: &crate::Lint =
&crate::Lint {
name: "DEPRECATED_SAFE_2024",
default_level: crate::Allow,
desc: "detects unsafe functions being used as safe functions",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "newly-unsafe-functions",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4982/// The `deprecated_safe_2024` lint detects unsafe functions being used as
4983 /// safe functions.
4984 ///
4985 /// ### Example
4986 ///
4987 /// ```rust,edition2021,compile_fail
4988 /// #![deny(deprecated_safe)]
4989 /// // edition 2021
4990 /// use std::env;
4991 /// fn enable_backtrace() {
4992 /// env::set_var("RUST_BACKTRACE", "1");
4993 /// }
4994 /// ```
4995 ///
4996 /// {{produces}}
4997 ///
4998 /// ### Explanation
4999 ///
5000 /// Rust [editions] allow the language to evolve without breaking backward
5001 /// compatibility. This lint catches code that uses `unsafe` functions that
5002 /// were declared as safe (non-`unsafe`) in editions prior to Rust 2024. If
5003 /// you switch the compiler to Rust 2024 without updating the code, then it
5004 /// will fail to compile if you are using a function previously marked as
5005 /// safe.
5006 ///
5007 /// You can audit the code to see if it suffices the preconditions of the
5008 /// `unsafe` code, and if it does, you can wrap it in an `unsafe` block. If
5009 /// you can't fulfill the preconditions, you probably need to switch to a
5010 /// different way of doing what you want to achieve.
5011 ///
5012 /// This lint can automatically wrap the calls in `unsafe` blocks, but this
5013 /// obviously cannot verify that the preconditions of the `unsafe`
5014 /// functions are fulfilled, so that is still up to the user.
5015 ///
5016 /// The lint is currently "allow" by default, but that might change in the
5017 /// future.
5018 ///
5019 /// [editions]: https://doc.rust-lang.org/edition-guide/
5020pub DEPRECATED_SAFE_2024,
5021 Allow,
5022"detects unsafe functions being used as safe functions",
5023 @future_incompatible = FutureIncompatibleInfo {
5024 reason: fcw!(EditionError 2024 "newly-unsafe-functions"),
5025 };
5026}50275028#[doc =
r" The `missing_unsafe_on_extern` lint detects missing unsafe keyword on extern declarations."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2021"]
#[doc = r" #![warn(missing_unsafe_on_extern)]"]
#[doc = r" #![allow(dead_code)]"]
#[doc = r""]
#[doc = r#" extern "C" {"#]
#[doc = r" fn foo(_: i32);"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Declaring extern items, even without ever using them, can cause Undefined Behavior. We"]
#[doc = r" should consider all sources of Undefined Behavior to be unsafe."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static MISSING_UNSAFE_ON_EXTERN: &crate::Lint =
&crate::Lint {
name: "MISSING_UNSAFE_ON_EXTERN",
default_level: crate::Allow,
desc: "detects missing unsafe keyword on extern declarations",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "unsafe-extern",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5029/// The `missing_unsafe_on_extern` lint detects missing unsafe keyword on extern declarations.
5030 ///
5031 /// ### Example
5032 ///
5033 /// ```rust,edition2021
5034 /// #![warn(missing_unsafe_on_extern)]
5035 /// #![allow(dead_code)]
5036 ///
5037 /// extern "C" {
5038 /// fn foo(_: i32);
5039 /// }
5040 ///
5041 /// fn main() {}
5042 /// ```
5043 ///
5044 /// {{produces}}
5045 ///
5046 /// ### Explanation
5047 ///
5048 /// Declaring extern items, even without ever using them, can cause Undefined Behavior. We
5049 /// should consider all sources of Undefined Behavior to be unsafe.
5050 ///
5051 /// This is a [future-incompatible] lint to transition this to a
5052 /// hard error in the future.
5053 ///
5054 /// [future-incompatible]: ../index.md#future-incompatible-lints
5055pub MISSING_UNSAFE_ON_EXTERN,
5056 Allow,
5057"detects missing unsafe keyword on extern declarations",
5058 @future_incompatible = FutureIncompatibleInfo {
5059 reason: fcw!(EditionError 2024 "unsafe-extern"),
5060 };
5061}50625063#[doc =
r" The `unsafe_attr_outside_unsafe` lint detects a missing unsafe keyword"]
#[doc = r" on attributes considered unsafe."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2021"]
#[doc = r" #![warn(unsafe_attr_outside_unsafe)]"]
#[doc = r""]
#[doc = r" #[no_mangle]"]
#[doc = r#" extern "C" fn foo() {}"#]
#[doc = r""]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Some attributes (e.g. `no_mangle`, `export_name`, `link_section` -- see"]
#[doc =
r#" [issue #82499] for a more complete list) are considered "unsafe" attributes."#]
#[doc = r" An unsafe attribute must only be used inside unsafe(...)."]
#[doc = r""]
#[doc =
r" This lint can automatically wrap the attributes in `unsafe(...)` , but this"]
#[doc = r" obviously cannot verify that the preconditions of the `unsafe`"]
#[doc = r" attributes are fulfilled, so that is still up to the user."]
#[doc = r""]
#[doc =
r#" The lint is currently "allow" by default, but that might change in the"#]
#[doc = r" future."]
#[doc = r""]
#[doc = r" [editions]: https://doc.rust-lang.org/edition-guide/"]
#[doc = r" [issue #82499]: https://github.com/rust-lang/rust/issues/82499"]
pub static UNSAFE_ATTR_OUTSIDE_UNSAFE: &crate::Lint =
&crate::Lint {
name: "UNSAFE_ATTR_OUTSIDE_UNSAFE",
default_level: crate::Allow,
desc: "detects unsafe attributes outside of unsafe",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "unsafe-attributes",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5064/// The `unsafe_attr_outside_unsafe` lint detects a missing unsafe keyword
5065 /// on attributes considered unsafe.
5066 ///
5067 /// ### Example
5068 ///
5069 /// ```rust,edition2021
5070 /// #![warn(unsafe_attr_outside_unsafe)]
5071 ///
5072 /// #[no_mangle]
5073 /// extern "C" fn foo() {}
5074 ///
5075 /// fn main() {}
5076 /// ```
5077 ///
5078 /// {{produces}}
5079 ///
5080 /// ### Explanation
5081 ///
5082 /// Some attributes (e.g. `no_mangle`, `export_name`, `link_section` -- see
5083 /// [issue #82499] for a more complete list) are considered "unsafe" attributes.
5084 /// An unsafe attribute must only be used inside unsafe(...).
5085 ///
5086 /// This lint can automatically wrap the attributes in `unsafe(...)` , but this
5087 /// obviously cannot verify that the preconditions of the `unsafe`
5088 /// attributes are fulfilled, so that is still up to the user.
5089 ///
5090 /// The lint is currently "allow" by default, but that might change in the
5091 /// future.
5092 ///
5093 /// [editions]: https://doc.rust-lang.org/edition-guide/
5094 /// [issue #82499]: https://github.com/rust-lang/rust/issues/82499
5095pub UNSAFE_ATTR_OUTSIDE_UNSAFE,
5096 Allow,
5097"detects unsafe attributes outside of unsafe",
5098 @future_incompatible = FutureIncompatibleInfo {
5099 reason: fcw!(EditionError 2024 "unsafe-attributes"),
5100 };
5101}51025103#[doc =
r" The `out_of_scope_macro_calls` lint detects `macro_rules` called when they are not in scope,"]
#[doc = r" above their definition, which may happen in key-value attributes."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![doc = in_root!()]"]
#[doc = r""]
#[doc = r#" macro_rules! in_root { () => { "" } }"#]
#[doc = r""]
#[doc = r" fn main() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The scope in which a `macro_rules` item is visible starts at that item and continues"]
#[doc =
r" below it. This is more similar to `let` than to other items, which are in scope both above"]
#[doc = r" and below their definition."]
#[doc =
r" Due to a bug `macro_rules` were accidentally in scope inside some key-value attributes"]
#[doc = r" above their definition. The lint catches such cases."]
#[doc =
r" To address the issue turn the `macro_rules` into a regularly scoped item by importing it"]
#[doc = r" with `use`."]
#[doc = r""]
#[doc = r" This is a [future-incompatible] lint to transition this to a"]
#[doc = r" hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static OUT_OF_SCOPE_MACRO_CALLS: &crate::Lint =
&crate::Lint {
name: "OUT_OF_SCOPE_MACRO_CALLS",
default_level: crate::Deny,
desc: "detects out of scope calls to `macro_rules` in key-value attributes",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 124535,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5104/// The `out_of_scope_macro_calls` lint detects `macro_rules` called when they are not in scope,
5105 /// above their definition, which may happen in key-value attributes.
5106 ///
5107 /// ### Example
5108 ///
5109 /// ```rust,compile_fail
5110 /// #![doc = in_root!()]
5111 ///
5112 /// macro_rules! in_root { () => { "" } }
5113 ///
5114 /// fn main() {}
5115 /// ```
5116 ///
5117 /// {{produces}}
5118 ///
5119 /// ### Explanation
5120 ///
5121 /// The scope in which a `macro_rules` item is visible starts at that item and continues
5122 /// below it. This is more similar to `let` than to other items, which are in scope both above
5123 /// and below their definition.
5124 /// Due to a bug `macro_rules` were accidentally in scope inside some key-value attributes
5125 /// above their definition. The lint catches such cases.
5126 /// To address the issue turn the `macro_rules` into a regularly scoped item by importing it
5127 /// with `use`.
5128 ///
5129 /// This is a [future-incompatible] lint to transition this to a
5130 /// hard error in the future.
5131 ///
5132 /// [future-incompatible]: ../index.md#future-incompatible-lints
5133pub OUT_OF_SCOPE_MACRO_CALLS,
5134 Deny,
5135"detects out of scope calls to `macro_rules` in key-value attributes",
5136 @future_incompatible = FutureIncompatibleInfo {
5137 reason: fcw!(FutureReleaseError #124535),
5138 report_in_deps: true,
5139 };
5140}51415142#[doc =
r" The `resolving_to_items_shadowing_supertrait_items` lint detects when the"]
#[doc =
r" usage of an item that is provided by both a subtrait and supertrait"]
#[doc = r" is shadowed, preferring the subtrait."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![feature(supertrait_item_shadowing)]"]
#[doc = r" #![deny(resolving_to_items_shadowing_supertrait_items)]"]
#[doc = r""]
#[doc = r" trait Upstream {"]
#[doc = r" fn hello(&self) {}"]
#[doc = r" }"]
#[doc = r" impl<T> Upstream for T {}"]
#[doc = r""]
#[doc = r" trait Downstream: Upstream {"]
#[doc = r" fn hello(&self) {}"]
#[doc = r" }"]
#[doc = r" impl<T> Downstream for T {}"]
#[doc = r""]
#[doc = r" struct MyType;"]
#[doc = r" MyType.hello();"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" RFC 3624 specified a heuristic in which a supertrait item would be"]
#[doc = r" shadowed by a subtrait item when ambiguity occurs during item"]
#[doc = r" selection. In order to mitigate side-effects of this happening"]
#[doc =
r" silently, this lint detects these cases when users want to deny them"]
#[doc = r" or fix the call sites."]
pub static RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS: &crate::Lint =
&crate::Lint {
name: "RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS",
default_level: crate::Allow,
desc: "detects when a supertrait item is shadowed by a subtrait item",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::supertrait_item_shadowing),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5143/// The `resolving_to_items_shadowing_supertrait_items` lint detects when the
5144 /// usage of an item that is provided by both a subtrait and supertrait
5145 /// is shadowed, preferring the subtrait.
5146 ///
5147 /// ### Example
5148 ///
5149 /// ```rust,compile_fail
5150 /// #![feature(supertrait_item_shadowing)]
5151 /// #![deny(resolving_to_items_shadowing_supertrait_items)]
5152 ///
5153 /// trait Upstream {
5154 /// fn hello(&self) {}
5155 /// }
5156 /// impl<T> Upstream for T {}
5157 ///
5158 /// trait Downstream: Upstream {
5159 /// fn hello(&self) {}
5160 /// }
5161 /// impl<T> Downstream for T {}
5162 ///
5163 /// struct MyType;
5164 /// MyType.hello();
5165 /// ```
5166 ///
5167 /// {{produces}}
5168 ///
5169 /// ### Explanation
5170 ///
5171 /// RFC 3624 specified a heuristic in which a supertrait item would be
5172 /// shadowed by a subtrait item when ambiguity occurs during item
5173 /// selection. In order to mitigate side-effects of this happening
5174 /// silently, this lint detects these cases when users want to deny them
5175 /// or fix the call sites.
5176pub RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS,
5177// FIXME(supertrait_item_shadowing): It is not decided if this should
5178 // warn by default at the call site.
5179Allow,
5180"detects when a supertrait item is shadowed by a subtrait item",
5181 @feature_gate = supertrait_item_shadowing;
5182}51835184#[doc = r" The `shadowing_supertrait_items` lint detects when the"]
#[doc = r" definition of an item that is provided by both a subtrait and"]
#[doc = r" supertrait is shadowed, preferring the subtrait."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" #![feature(supertrait_item_shadowing)]"]
#[doc = r" #![deny(shadowing_supertrait_items)]"]
#[doc = r""]
#[doc = r" trait Upstream {"]
#[doc = r" fn hello(&self) {}"]
#[doc = r" }"]
#[doc = r" impl<T> Upstream for T {}"]
#[doc = r""]
#[doc = r" trait Downstream: Upstream {"]
#[doc = r" fn hello(&self) {}"]
#[doc = r" }"]
#[doc = r" impl<T> Downstream for T {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" RFC 3624 specified a heuristic in which a supertrait item would be"]
#[doc = r" shadowed by a subtrait item when ambiguity occurs during item"]
#[doc = r" selection. In order to mitigate side-effects of this happening"]
#[doc =
r" silently, this lint detects these cases when users want to deny them"]
#[doc = r" or fix their trait definitions."]
pub static SHADOWING_SUPERTRAIT_ITEMS: &crate::Lint =
&crate::Lint {
name: "SHADOWING_SUPERTRAIT_ITEMS",
default_level: crate::Allow,
desc: "detects when a supertrait item is shadowed by a subtrait item",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::supertrait_item_shadowing),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5185/// The `shadowing_supertrait_items` lint detects when the
5186 /// definition of an item that is provided by both a subtrait and
5187 /// supertrait is shadowed, preferring the subtrait.
5188 ///
5189 /// ### Example
5190 ///
5191 /// ```rust,compile_fail
5192 /// #![feature(supertrait_item_shadowing)]
5193 /// #![deny(shadowing_supertrait_items)]
5194 ///
5195 /// trait Upstream {
5196 /// fn hello(&self) {}
5197 /// }
5198 /// impl<T> Upstream for T {}
5199 ///
5200 /// trait Downstream: Upstream {
5201 /// fn hello(&self) {}
5202 /// }
5203 /// impl<T> Downstream for T {}
5204 /// ```
5205 ///
5206 /// {{produces}}
5207 ///
5208 /// ### Explanation
5209 ///
5210 /// RFC 3624 specified a heuristic in which a supertrait item would be
5211 /// shadowed by a subtrait item when ambiguity occurs during item
5212 /// selection. In order to mitigate side-effects of this happening
5213 /// silently, this lint detects these cases when users want to deny them
5214 /// or fix their trait definitions.
5215pub SHADOWING_SUPERTRAIT_ITEMS,
5216// FIXME(supertrait_item_shadowing): It is not decided if this should
5217 // warn by default at the usage site.
5218Allow,
5219"detects when a supertrait item is shadowed by a subtrait item",
5220 @feature_gate = supertrait_item_shadowing;
5221}52225223#[doc =
r" The `tail_expr_drop_order` lint looks for those values generated at the tail expression location,"]
#[doc = r" that runs a custom `Drop` destructor."]
#[doc =
r" Some of them may be dropped earlier in Edition 2024 that they used to in Edition 2021 and prior."]
#[doc =
r" This lint detects those cases and provides you information on those values and their custom destructor implementations."]
#[doc = r" Your discretion on this information is required."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r" ```rust,edition2021"]
#[doc = r" #![warn(tail_expr_drop_order)]"]
#[doc = r" struct Droppy(i32);"]
#[doc = r" impl Droppy {"]
#[doc = r" fn get(&self) -> i32 {"]
#[doc = r" self.0"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" impl Drop for Droppy {"]
#[doc = r" fn drop(&mut self) {"]
#[doc =
r" // This is a custom destructor and it induces side-effects that is observable"]
#[doc =
r" // especially when the drop order at a tail expression changes."]
#[doc = r#" println!("loud drop {}", self.0);"#]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" fn edition_2021() -> i32 {"]
#[doc = r" let another_droppy = Droppy(0);"]
#[doc = r" Droppy(1).get()"]
#[doc = r" }"]
#[doc = r" fn main() {"]
#[doc = r" edition_2021();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" In tail expression of blocks or function bodies,"]
#[doc =
r" values of type with significant `Drop` implementation has an ill-specified drop order"]
#[doc =
r" before Edition 2024 so that they are dropped only after dropping local variables."]
#[doc = r" Edition 2024 introduces a new rule with drop orders for them,"]
#[doc = r" so that they are dropped first before dropping local variables."]
#[doc = r""]
#[doc =
r" A significant `Drop::drop` destructor here refers to an explicit, arbitrary"]
#[doc =
r" implementation of the `Drop` trait on the type, with exceptions including `Vec`,"]
#[doc =
r" `Box`, `Rc`, `BTreeMap` and `HashMap` that are marked by the compiler otherwise"]
#[doc =
r" so long that the generic types have no significant destructor recursively."]
#[doc =
r" In other words, a type has a significant drop destructor when it has a `Drop` implementation"]
#[doc = r" or its destructor invokes a significant destructor on a type."]
#[doc =
r" Since we cannot completely reason about the change by just inspecting the existence of"]
#[doc =
r" a significant destructor, this lint remains only a suggestion and is set to `allow` by default."]
#[doc = r""]
#[doc =
r" This lint only points out the issue with `Droppy`, which will be dropped before `another_droppy`"]
#[doc = r" does in Edition 2024."]
#[doc = r" No fix will be proposed by this lint."]
#[doc =
r" However, the most probable fix is to hoist `Droppy` into its own local variable binding."]
#[doc = r" ```rust"]
#[doc = r" struct Droppy(i32);"]
#[doc = r" impl Droppy {"]
#[doc = r" fn get(&self) -> i32 {"]
#[doc = r" self.0"]
#[doc = r" }"]
#[doc = r" }"]
#[doc = r" fn edition_2024() -> i32 {"]
#[doc = r" let value = Droppy(0);"]
#[doc = r" let another_droppy = Droppy(1);"]
#[doc = r" value.get()"]
#[doc = r" }"]
#[doc = r" ```"]
pub static TAIL_EXPR_DROP_ORDER: &crate::Lint =
&crate::Lint {
name: "TAIL_EXPR_DROP_ORDER",
default_level: crate::Allow,
desc: "Detect and warn on significant change in drop order in tail expression location",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionSemanticsChange(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "temporary-tail-expr-scope",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5224/// The `tail_expr_drop_order` lint looks for those values generated at the tail expression location,
5225 /// that runs a custom `Drop` destructor.
5226 /// Some of them may be dropped earlier in Edition 2024 that they used to in Edition 2021 and prior.
5227 /// This lint detects those cases and provides you information on those values and their custom destructor implementations.
5228 /// Your discretion on this information is required.
5229 ///
5230 /// ### Example
5231 /// ```rust,edition2021
5232 /// #![warn(tail_expr_drop_order)]
5233 /// struct Droppy(i32);
5234 /// impl Droppy {
5235 /// fn get(&self) -> i32 {
5236 /// self.0
5237 /// }
5238 /// }
5239 /// impl Drop for Droppy {
5240 /// fn drop(&mut self) {
5241 /// // This is a custom destructor and it induces side-effects that is observable
5242 /// // especially when the drop order at a tail expression changes.
5243 /// println!("loud drop {}", self.0);
5244 /// }
5245 /// }
5246 /// fn edition_2021() -> i32 {
5247 /// let another_droppy = Droppy(0);
5248 /// Droppy(1).get()
5249 /// }
5250 /// fn main() {
5251 /// edition_2021();
5252 /// }
5253 /// ```
5254 ///
5255 /// {{produces}}
5256 ///
5257 /// ### Explanation
5258 ///
5259 /// In tail expression of blocks or function bodies,
5260 /// values of type with significant `Drop` implementation has an ill-specified drop order
5261 /// before Edition 2024 so that they are dropped only after dropping local variables.
5262 /// Edition 2024 introduces a new rule with drop orders for them,
5263 /// so that they are dropped first before dropping local variables.
5264 ///
5265 /// A significant `Drop::drop` destructor here refers to an explicit, arbitrary
5266 /// implementation of the `Drop` trait on the type, with exceptions including `Vec`,
5267 /// `Box`, `Rc`, `BTreeMap` and `HashMap` that are marked by the compiler otherwise
5268 /// so long that the generic types have no significant destructor recursively.
5269 /// In other words, a type has a significant drop destructor when it has a `Drop` implementation
5270 /// or its destructor invokes a significant destructor on a type.
5271 /// Since we cannot completely reason about the change by just inspecting the existence of
5272 /// a significant destructor, this lint remains only a suggestion and is set to `allow` by default.
5273 ///
5274 /// This lint only points out the issue with `Droppy`, which will be dropped before `another_droppy`
5275 /// does in Edition 2024.
5276 /// No fix will be proposed by this lint.
5277 /// However, the most probable fix is to hoist `Droppy` into its own local variable binding.
5278 /// ```rust
5279 /// struct Droppy(i32);
5280 /// impl Droppy {
5281 /// fn get(&self) -> i32 {
5282 /// self.0
5283 /// }
5284 /// }
5285 /// fn edition_2024() -> i32 {
5286 /// let value = Droppy(0);
5287 /// let another_droppy = Droppy(1);
5288 /// value.get()
5289 /// }
5290 /// ```
5291pub TAIL_EXPR_DROP_ORDER,
5292 Allow,
5293"Detect and warn on significant change in drop order in tail expression location",
5294 @future_incompatible = FutureIncompatibleInfo {
5295 reason: fcw!(EditionSemanticsChange 2024 "temporary-tail-expr-scope"),
5296 };
5297}52985299#[doc =
r" The `rust_2024_guarded_string_incompatible_syntax` lint detects `#` tokens"]
#[doc =
r" that will be parsed as part of a guarded string literal in Rust 2024."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,edition2021,compile_fail"]
#[doc = r" #![deny(rust_2024_guarded_string_incompatible_syntax)]"]
#[doc = r""]
#[doc = r" macro_rules! m {"]
#[doc = r" (# $x:expr #) => ();"]
#[doc = r" (# $x:expr) => ();"]
#[doc = r" }"]
#[doc = r""]
#[doc = r##" m!(#"hey"#);"##]
#[doc = r#" m!(#"hello");"#]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r##" Prior to Rust 2024, `#"hey"#` is three tokens: the first `#`"##]
#[doc = r#" followed by the string literal `"hey"` then the final `#`."#]
#[doc = r" In Rust 2024, the whole sequence is considered a single token."]
#[doc = r""]
#[doc = r" This lint suggests to add whitespace between the leading `#`"]
#[doc = r" and the string to keep them separated in Rust 2024."]
#[allow(rustdoc::invalid_rust_codeblocks)]
pub static RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX: &crate::Lint =
&crate::Lint {
name: "RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX",
default_level: crate::Allow,
desc: "will be parsed as a guarded string in Rust 2024",
is_externally_loaded: false,
crate_level_only: true,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::EditionError(crate::EditionFcw {
edition: rustc_span::edition::Edition::Edition2024,
page_slug: "reserved-syntax",
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5300/// The `rust_2024_guarded_string_incompatible_syntax` lint detects `#` tokens
5301 /// that will be parsed as part of a guarded string literal in Rust 2024.
5302 ///
5303 /// ### Example
5304 ///
5305 /// ```rust,edition2021,compile_fail
5306 /// #![deny(rust_2024_guarded_string_incompatible_syntax)]
5307 ///
5308 /// macro_rules! m {
5309 /// (# $x:expr #) => ();
5310 /// (# $x:expr) => ();
5311 /// }
5312 ///
5313 /// m!(#"hey"#);
5314 /// m!(#"hello");
5315 /// ```
5316 ///
5317 /// {{produces}}
5318 ///
5319 /// ### Explanation
5320 ///
5321 /// Prior to Rust 2024, `#"hey"#` is three tokens: the first `#`
5322 /// followed by the string literal `"hey"` then the final `#`.
5323 /// In Rust 2024, the whole sequence is considered a single token.
5324 ///
5325 /// This lint suggests to add whitespace between the leading `#`
5326 /// and the string to keep them separated in Rust 2024.
5327// Allow this lint -- rustdoc doesn't yet support threading edition into this lint's parser.
5328#[allow(rustdoc::invalid_rust_codeblocks)]
5329pub RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX,
5330 Allow,
5331"will be parsed as a guarded string in Rust 2024",
5332 @future_incompatible = FutureIncompatibleInfo {
5333 reason: fcw!(EditionError 2024 "reserved-syntax"),
5334 };
5335 crate_level_only
5336}53375338#[doc =
r#" The `aarch64_softfloat_neon` lint detects usage of `#[target_feature(enable = "neon")]` on"#]
#[doc =
r" softfloat aarch64 targets. Enabling this target feature causes LLVM to alter the ABI of"]
#[doc = r" function calls, making this attribute unsound to use."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs aarch64-unknown-none-softfloat)"]
#[doc = r#" #[target_feature(enable = "neon")]"#]
#[doc = r" fn with_neon() {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" error: enabling the `neon` target feature on the current target is unsound due to ABI issues"]
#[doc = r" --> $DIR/abi-incompatible-target-feature-attribute-fcw.rs:11:18"]
#[doc = r" |"]
#[doc = r#" | #[target_feature(enable = "neon")]"#]
#[doc = r" | ^^^^^^^^^^^^^^^"]
#[doc = r" |"]
#[doc =
r" = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!"]
#[doc =
r" = note: for more information, see issue #134375 <https://github.com/rust-lang/rust/issues/134375>"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" If a function like `with_neon` above ends up containing calls to LLVM builtins, those will"]
#[doc =
r" not use the correct ABI. This is caused by a lack of support in LLVM for mixing code with"]
#[doc =
r" and without the `neon` target feature. The target feature should never have been stabilized"]
#[doc =
r" on this target due to this issue, but the problem was not known at the time of"]
#[doc = r" stabilization."]
pub static AARCH64_SOFTFLOAT_NEON: &crate::Lint =
&crate::Lint {
name: "AARCH64_SOFTFLOAT_NEON",
default_level: crate::Warn,
desc: "detects code that could be affected by ABI issues on aarch64 softfloat targets",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 134375,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5339/// The `aarch64_softfloat_neon` lint detects usage of `#[target_feature(enable = "neon")]` on
5340 /// softfloat aarch64 targets. Enabling this target feature causes LLVM to alter the ABI of
5341 /// function calls, making this attribute unsound to use.
5342 ///
5343 /// ### Example
5344 ///
5345 /// ```rust,ignore (needs aarch64-unknown-none-softfloat)
5346 /// #[target_feature(enable = "neon")]
5347 /// fn with_neon() {}
5348 /// ```
5349 ///
5350 /// This will produce:
5351 ///
5352 /// ```text
5353 /// error: enabling the `neon` target feature on the current target is unsound due to ABI issues
5354 /// --> $DIR/abi-incompatible-target-feature-attribute-fcw.rs:11:18
5355 /// |
5356 /// | #[target_feature(enable = "neon")]
5357 /// | ^^^^^^^^^^^^^^^
5358 /// |
5359 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
5360 /// = note: for more information, see issue #134375 <https://github.com/rust-lang/rust/issues/134375>
5361 /// ```
5362 ///
5363 /// ### Explanation
5364 ///
5365 /// If a function like `with_neon` above ends up containing calls to LLVM builtins, those will
5366 /// not use the correct ABI. This is caused by a lack of support in LLVM for mixing code with
5367 /// and without the `neon` target feature. The target feature should never have been stabilized
5368 /// on this target due to this issue, but the problem was not known at the time of
5369 /// stabilization.
5370pub AARCH64_SOFTFLOAT_NEON,
5371 Warn,
5372"detects code that could be affected by ABI issues on aarch64 softfloat targets",
5373 @future_incompatible = FutureIncompatibleInfo {
5374 reason: fcw!(FutureReleaseError #134375),
5375 report_in_deps: true,
5376 };
5377}53785379#[doc =
r" The `tail_call_track_caller` lint detects usage of `become` attempting to tail call"]
#[doc = r" a function marked with `#[track_caller]`."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" #![feature(explicit_tail_calls)]"]
#[doc = r" #![expect(incomplete_features)]"]
#[doc = r""]
#[doc = r" #[track_caller]"]
#[doc = r" fn f() {}"]
#[doc = r""]
#[doc = r" fn g() {"]
#[doc = r" become f();"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" g();"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Due to implementation details of tail calls and `#[track_caller]` attribute, calls to"]
#[doc =
r" functions marked with `#[track_caller]` cannot become tail calls. As such using `become`"]
#[doc =
r" is no different than a normal call (except for changes in drop order)."]
pub static TAIL_CALL_TRACK_CALLER: &crate::Lint =
&crate::Lint {
name: "TAIL_CALL_TRACK_CALLER",
default_level: crate::Warn,
desc: "detects tail calls of functions marked with `#[track_caller]`",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::explicit_tail_calls),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5380/// The `tail_call_track_caller` lint detects usage of `become` attempting to tail call
5381 /// a function marked with `#[track_caller]`.
5382 ///
5383 /// ### Example
5384 ///
5385 /// ```rust
5386 /// #![feature(explicit_tail_calls)]
5387 /// #![expect(incomplete_features)]
5388 ///
5389 /// #[track_caller]
5390 /// fn f() {}
5391 ///
5392 /// fn g() {
5393 /// become f();
5394 /// }
5395 ///
5396 /// g();
5397 /// ```
5398 ///
5399 /// {{produces}}
5400 ///
5401 /// ### Explanation
5402 ///
5403 /// Due to implementation details of tail calls and `#[track_caller]` attribute, calls to
5404 /// functions marked with `#[track_caller]` cannot become tail calls. As such using `become`
5405 /// is no different than a normal call (except for changes in drop order).
5406pub TAIL_CALL_TRACK_CALLER,
5407 Warn,
5408"detects tail calls of functions marked with `#[track_caller]`",
5409 @feature_gate = explicit_tail_calls;
5410}5411#[doc =
r" The `inline_always_mismatching_target_features` lint will trigger when a"]
#[doc =
r#" function with the `#[inline(always)]` and `#[target_feature(enable = "...")]`"#]
#[doc =
r" attributes is called and cannot be inlined due to missing target features in the caller."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (fails on x86_64)"]
#[doc = r" #[inline(always)]"]
#[doc = r#" #[target_feature(enable = "fp16")]"#]
#[doc = r" unsafe fn callee() {"]
#[doc = r" // operations using fp16 types"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" // Caller does not enable the required target feature"]
#[doc = r" fn caller() {"]
#[doc = r" unsafe { callee(); }"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" caller();"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" warning: call to `#[inline(always)]`-annotated `callee` requires the same target features. Function will not have `alwaysinline` attribute applied"]
#[doc = r" --> $DIR/builtin.rs:5192:14"]
#[doc = r" |"]
#[doc = r" 10 | unsafe { callee(); }"]
#[doc = r" | ^^^^^^^^"]
#[doc = r" |"]
#[doc =
r" note: `fp16` target feature enabled in `callee` here but missing from `caller`"]
#[doc = r" --> $DIR/builtin.rs:5185:1"]
#[doc = r" |"]
#[doc = r#" 3 | #[target_feature(enable = "fp16")]"#]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc = r" 4 | unsafe fn callee() {"]
#[doc = r" | ------------------"]
#[doc =
r" = note: `#[warn(inline_always_mismatching_target_features)]` on by default"]
#[doc = r" warning: 1 warning emitted"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Inlining a function with a target feature attribute into a caller that"]
#[doc =
r" lacks the corresponding target feature can lead to unsound behavior."]
#[doc = r" LLVM may select the wrong instructions or registers, or reorder"]
#[doc = r" operations, potentially resulting in runtime errors."]
pub static INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES: &crate::Lint =
&crate::Lint {
name: "INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES",
default_level: crate::Warn,
desc: r#"detects when a function annotated with `#[inline(always)]` and `#[target_feature(enable = "..")]` is inlined into a caller without the required target feature"#,
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5412/// The `inline_always_mismatching_target_features` lint will trigger when a
5413 /// function with the `#[inline(always)]` and `#[target_feature(enable = "...")]`
5414 /// attributes is called and cannot be inlined due to missing target features in the caller.
5415 ///
5416 /// ### Example
5417 ///
5418 /// ```rust,ignore (fails on x86_64)
5419 /// #[inline(always)]
5420 /// #[target_feature(enable = "fp16")]
5421 /// unsafe fn callee() {
5422 /// // operations using fp16 types
5423 /// }
5424 ///
5425 /// // Caller does not enable the required target feature
5426 /// fn caller() {
5427 /// unsafe { callee(); }
5428 /// }
5429 ///
5430 /// fn main() {
5431 /// caller();
5432 /// }
5433 /// ```
5434 ///
5435 /// This will produce:
5436 ///
5437 /// ```text
5438 /// warning: call to `#[inline(always)]`-annotated `callee` requires the same target features. Function will not have `alwaysinline` attribute applied
5439 /// --> $DIR/builtin.rs:5192:14
5440 /// |
5441 /// 10 | unsafe { callee(); }
5442 /// | ^^^^^^^^
5443 /// |
5444 /// note: `fp16` target feature enabled in `callee` here but missing from `caller`
5445 /// --> $DIR/builtin.rs:5185:1
5446 /// |
5447 /// 3 | #[target_feature(enable = "fp16")]
5448 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5449 /// 4 | unsafe fn callee() {
5450 /// | ------------------
5451 /// = note: `#[warn(inline_always_mismatching_target_features)]` on by default
5452 /// warning: 1 warning emitted
5453 /// ```
5454 ///
5455 /// ### Explanation
5456 ///
5457 /// Inlining a function with a target feature attribute into a caller that
5458 /// lacks the corresponding target feature can lead to unsound behavior.
5459 /// LLVM may select the wrong instructions or registers, or reorder
5460 /// operations, potentially resulting in runtime errors.
5461pub INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES,
5462 Warn,
5463r#"detects when a function annotated with `#[inline(always)]` and `#[target_feature(enable = "..")]` is inlined into a caller without the required target feature"#,
5464}54655466#[doc =
r" The `repr_c_enums_larger_than_int` lint detects `repr(C)` enums with discriminant"]
#[doc = r" values that do not fit into a C `int` or `unsigned int`."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (only errors on 64bit)"]
#[doc = r" #[repr(C)]"]
#[doc = r" enum E {"]
#[doc = r" V = 9223372036854775807, // i64::MAX"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" error: `repr(C)` enum discriminant does not fit into C `int` nor into C `unsigned int`"]
#[doc = r" --> $DIR/repr-c-big-discriminant1.rs:16:5"]
#[doc = r" |"]
#[doc = r" LL | A = 9223372036854775807, // i64::MAX"]
#[doc = r" | ^"]
#[doc = r" |"]
#[doc =
r" = note: `repr(C)` enums with big discriminants are non-portable, and their size in Rust might not match their size in C"]
#[doc =
r" = help: use `repr($int_ty)` instead to explicitly set the size of this enum"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" In C, enums with discriminants that do not all fit into an `int` or all fit into an"]
#[doc =
r" `unsigned int` are a portability hazard: such enums are only permitted since C23, and not"]
#[doc = r" supported e.g. by MSVC."]
#[doc = r""]
#[doc =
r" Furthermore, Rust interprets the discriminant values of `repr(C)` enums as expressions of"]
#[doc =
r" type `isize`. This makes it impossible to implement the C23 behavior of enums where the enum"]
#[doc =
r" discriminants have no predefined type and instead the enum uses a type large enough to hold"]
#[doc = r" all discriminants."]
#[doc = r""]
#[doc =
r" Therefore, `repr(C)` enums in Rust require that either all discriminants to fit into a C"]
#[doc = r" `int` or they all fit into an `unsigned int`."]
pub static REPR_C_ENUMS_LARGER_THAN_INT: &crate::Lint =
&crate::Lint {
name: "REPR_C_ENUMS_LARGER_THAN_INT",
default_level: crate::Warn,
desc: "repr(C) enums with discriminant values that do not fit into a C int",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 124403,
}),
report_in_deps: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5467/// The `repr_c_enums_larger_than_int` lint detects `repr(C)` enums with discriminant
5468 /// values that do not fit into a C `int` or `unsigned int`.
5469 ///
5470 /// ### Example
5471 ///
5472 /// ```rust,ignore (only errors on 64bit)
5473 /// #[repr(C)]
5474 /// enum E {
5475 /// V = 9223372036854775807, // i64::MAX
5476 /// }
5477 /// ```
5478 ///
5479 /// This will produce:
5480 ///
5481 /// ```text
5482 /// error: `repr(C)` enum discriminant does not fit into C `int` nor into C `unsigned int`
5483 /// --> $DIR/repr-c-big-discriminant1.rs:16:5
5484 /// |
5485 /// LL | A = 9223372036854775807, // i64::MAX
5486 /// | ^
5487 /// |
5488 /// = note: `repr(C)` enums with big discriminants are non-portable, and their size in Rust might not match their size in C
5489 /// = help: use `repr($int_ty)` instead to explicitly set the size of this enum
5490 /// ```
5491 ///
5492 /// ### Explanation
5493 ///
5494 /// In C, enums with discriminants that do not all fit into an `int` or all fit into an
5495 /// `unsigned int` are a portability hazard: such enums are only permitted since C23, and not
5496 /// supported e.g. by MSVC.
5497 ///
5498 /// Furthermore, Rust interprets the discriminant values of `repr(C)` enums as expressions of
5499 /// type `isize`. This makes it impossible to implement the C23 behavior of enums where the enum
5500 /// discriminants have no predefined type and instead the enum uses a type large enough to hold
5501 /// all discriminants.
5502 ///
5503 /// Therefore, `repr(C)` enums in Rust require that either all discriminants to fit into a C
5504 /// `int` or they all fit into an `unsigned int`.
5505pub REPR_C_ENUMS_LARGER_THAN_INT,
5506 Warn,
5507"repr(C) enums with discriminant values that do not fit into a C int",
5508 @future_incompatible = FutureIncompatibleInfo {
5509 reason: fcw!(FutureReleaseError #124403),
5510 report_in_deps: false,
5511 };
5512}55135514#[doc =
r" The `varargs_without_pattern` lint detects when `...` is used as an argument to a"]
#[doc = r" non-foreign function without any pattern being specified."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc =
r" // Using `...` in non-foreign function definitions is unstable, however stability is"]
#[doc =
r" // currently only checked after attributes are expanded, so using `#[cfg(false)]` here will"]
#[doc = r" // allow this to compile on stable Rust."]
#[doc = r" #[cfg(false)]"]
#[doc = r" fn foo(...) {"]
#[doc = r""]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Patterns are currently required for all non-`...` arguments in function definitions (with"]
#[doc =
r" some exceptions in the 2015 edition). Requiring `...` arguments to have patterns in"]
#[doc =
r" non-foreign function definitions makes the language more consistent, and removes a source of"]
#[doc =
r" confusion for the unstable C variadic feature. `...` arguments without a pattern are already"]
#[doc =
r" stable and widely used in foreign function definitions; this lint only affects non-foreign"]
#[doc = r" function definitions."]
#[doc = r""]
#[doc =
r" Using `...` (C varargs) in a non-foreign function definition is currently unstable. However,"]
#[doc =
r" stability checking for the `...` syntax in non-foreign function definitions is currently"]
#[doc =
r" implemented after attributes have been expanded, meaning that if the attribute removes the"]
#[doc =
r" use of the unstable syntax (e.g. `#[cfg(false)]`, or a procedural macro), the code will"]
#[doc =
r" compile on stable Rust; this is the only situation where this lint affects code that"]
#[doc = r" compiles on stable Rust."]
#[doc = r""]
#[doc =
r" This is a [future-incompatible] lint to transition this to a hard error in the future."]
#[doc = r""]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static VARARGS_WITHOUT_PATTERN: &crate::Lint =
&crate::Lint {
name: "VARARGS_WITHOUT_PATTERN",
default_level: crate::Warn,
desc: "detects usage of `...` arguments without a pattern in non-foreign items",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 145544,
}),
report_in_deps: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5515/// The `varargs_without_pattern` lint detects when `...` is used as an argument to a
5516 /// non-foreign function without any pattern being specified.
5517 ///
5518 /// ### Example
5519 ///
5520 /// ```rust
5521 /// // Using `...` in non-foreign function definitions is unstable, however stability is
5522 /// // currently only checked after attributes are expanded, so using `#[cfg(false)]` here will
5523 /// // allow this to compile on stable Rust.
5524 /// #[cfg(false)]
5525 /// fn foo(...) {
5526 ///
5527 /// }
5528 /// ```
5529 ///
5530 /// {{produces}}
5531 ///
5532 /// ### Explanation
5533 ///
5534 /// Patterns are currently required for all non-`...` arguments in function definitions (with
5535 /// some exceptions in the 2015 edition). Requiring `...` arguments to have patterns in
5536 /// non-foreign function definitions makes the language more consistent, and removes a source of
5537 /// confusion for the unstable C variadic feature. `...` arguments without a pattern are already
5538 /// stable and widely used in foreign function definitions; this lint only affects non-foreign
5539 /// function definitions.
5540 ///
5541 /// Using `...` (C varargs) in a non-foreign function definition is currently unstable. However,
5542 /// stability checking for the `...` syntax in non-foreign function definitions is currently
5543 /// implemented after attributes have been expanded, meaning that if the attribute removes the
5544 /// use of the unstable syntax (e.g. `#[cfg(false)]`, or a procedural macro), the code will
5545 /// compile on stable Rust; this is the only situation where this lint affects code that
5546 /// compiles on stable Rust.
5547 ///
5548 /// This is a [future-incompatible] lint to transition this to a hard error in the future.
5549 ///
5550 /// [future-incompatible]: ../index.md#future-incompatible-lints
5551pub VARARGS_WITHOUT_PATTERN,
5552 Warn,
5553"detects usage of `...` arguments without a pattern in non-foreign items",
5554 @future_incompatible = FutureIncompatibleInfo {
5555 reason: fcw!(FutureReleaseError #145544),
5556 report_in_deps: false,
5557 };
5558}