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_LLVM_INTRINSIC,
DEPRECATED_SAFE_2024, DEPRECATED_WHERE_CLAUSE_LOCATION,
DUPLICATE_FEATURES, DUPLICATE_MACRO_ATTRIBUTES,
ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
ELIDED_LIFETIMES_IN_PATHS, EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
EXPORTED_PRIVATE_DEPENDENCIES, FFI_UNWIND_CALLS,
FLOAT_LITERAL_F32_FALLBACK, 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_INFO, 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,
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_LLVM_INTRINSIC,
DEPRECATED_SAFE_2024, DEPRECATED_WHERE_CLAUSE_LOCATION,
DUPLICATE_FEATURES, DUPLICATE_MACRO_ATTRIBUTES,
ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
ELIDED_LIFETIMES_IN_PATHS, EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
EXPORTED_PRIVATE_DEPENDENCIES, FFI_UNWIND_CALLS,
FLOAT_LITERAL_F32_FALLBACK, 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_INFO, 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,
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_LLVM_INTRINSIC,
41 DEPRECATED_SAFE_2024,
42 DEPRECATED_WHERE_CLAUSE_LOCATION,
43 DUPLICATE_FEATURES,
44 DUPLICATE_MACRO_ATTRIBUTES,
45 ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
46 ELIDED_LIFETIMES_IN_PATHS,
47 EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
48 EXPORTED_PRIVATE_DEPENDENCIES,
49 FFI_UNWIND_CALLS,
50 FLOAT_LITERAL_F32_FALLBACK,
51 FORBIDDEN_LINT_GROUPS,
52 FUNCTION_ITEM_REFERENCES,
53 FUZZY_PROVENANCE_CASTS,
54 HIDDEN_GLOB_REEXPORTS,
55 ILL_FORMED_ATTRIBUTE_INPUT,
56 INCOMPLETE_INCLUDE,
57 INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
58 INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES,
59 INLINE_NO_SANITIZE,
60 INVALID_DOC_ATTRIBUTES,
61 INVALID_MACRO_EXPORT_ARGUMENTS,
62 INVALID_TYPE_PARAM_DEFAULT,
63 IRREFUTABLE_LET_PATTERNS,
64 LARGE_ASSIGNMENTS,
65 LATE_BOUND_LIFETIME_ARGUMENTS,
66 LEGACY_DERIVE_HELPERS,
67 LINKER_INFO,
68 LINKER_MESSAGES,
69 LONG_RUNNING_CONST_EVAL,
70 LOSSY_PROVENANCE_CASTS,
71 MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
72 MACRO_USE_EXTERN_CRATE,
73 MALFORMED_DIAGNOSTIC_ATTRIBUTES,
74 MALFORMED_DIAGNOSTIC_FORMAT_LITERALS,
75 META_VARIABLE_MISUSE,
76 MISPLACED_DIAGNOSTIC_ATTRIBUTES,
77 MISSING_ABI,
78 MISSING_UNSAFE_ON_EXTERN,
79 MUST_NOT_SUSPEND,
80 NAMED_ARGUMENTS_USED_POSITIONALLY,
81 NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE,
82 NON_CONTIGUOUS_RANGE_ENDPOINTS,
83 NON_EXHAUSTIVE_OMITTED_PATTERNS,
84 OUT_OF_SCOPE_MACRO_CALLS,
85 OVERLAPPING_RANGE_ENDPOINTS,
86 PATTERNS_IN_FNS_WITHOUT_BODY,
87 PRIVATE_BOUNDS,
88 PRIVATE_INTERFACES,
89 PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
90 PUB_USE_OF_PRIVATE_EXTERN_CRATE,
91 REDUNDANT_IMPORTS,
92 REDUNDANT_LIFETIMES,
93 REFINING_IMPL_TRAIT_INTERNAL,
94 REFINING_IMPL_TRAIT_REACHABLE,
95 RENAMED_AND_REMOVED_LINTS,
96 REPR_C_ENUMS_LARGER_THAN_INT,
97 REPR_TRANSPARENT_NON_ZST_FIELDS,
98 RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS,
99 RTSAN_NONBLOCKING_ASYNC,
100 RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
101 RUST_2021_INCOMPATIBLE_OR_PATTERNS,
102 RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
103 RUST_2021_PRELUDE_COLLISIONS,
104 RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX,
105 RUST_2024_INCOMPATIBLE_PAT,
106 RUST_2024_PRELUDE_COLLISIONS,
107 SELF_CONSTRUCTOR_FROM_OUTER_ITEM,
108 SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
109 SHADOWING_SUPERTRAIT_ITEMS,
110 SINGLE_USE_LIFETIMES,
111 STABLE_FEATURES,
112 TAIL_EXPR_DROP_ORDER,
113 TEST_UNSTABLE_LINT,
114 TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
115 TEXT_DIRECTION_CODEPOINT_IN_LITERAL,
116 TRIVIAL_CASTS,
117 TRIVIAL_NUMERIC_CASTS,
118 TYVAR_BEHIND_RAW_POINTER,
119 UNCONDITIONAL_PANIC,
120 UNCONDITIONAL_RECURSION,
121 UNCOVERED_PARAM_IN_PROJECTION,
122 UNEXPECTED_CFGS,
123 UNFULFILLED_LINT_EXPECTATIONS,
124 UNINHABITED_STATIC,
125 UNKNOWN_CRATE_TYPES,
126 UNKNOWN_DIAGNOSTIC_ATTRIBUTES,
127 UNKNOWN_LINTS,
128 UNNAMEABLE_TEST_ITEMS,
129 UNNAMEABLE_TYPES,
130 UNREACHABLE_CFG_SELECT_PREDICATES,
131 UNREACHABLE_CODE,
132 UNREACHABLE_PATTERNS,
133 UNSAFE_ATTR_OUTSIDE_UNSAFE,
134 UNSAFE_OP_IN_UNSAFE_FN,
135 UNSTABLE_NAME_COLLISIONS,
136 UNSTABLE_SYNTAX_PRE_EXPANSION,
137 UNSUPPORTED_CALLING_CONVENTIONS,
138 UNUSED_ASSIGNMENTS,
139 UNUSED_ASSOCIATED_TYPE_BOUNDS,
140 UNUSED_ATTRIBUTES,
141 UNUSED_CRATE_DEPENDENCIES,
142 UNUSED_EXTERN_CRATES,
143 UNUSED_FEATURES,
144 UNUSED_IMPORTS,
145 UNUSED_LABELS,
146 UNUSED_LIFETIMES,
147 UNUSED_MACROS,
148 UNUSED_MACRO_RULES,
149 UNUSED_MUT,
150 UNUSED_QUALIFICATIONS,
151 UNUSED_UNSAFE,
152 UNUSED_VARIABLES,
153 UNUSED_VISIBILITIES,
154 USELESS_DEPRECATED,
155 VARARGS_WITHOUT_PATTERN,
156 WARNINGS,
157// tidy-alphabetical-end
158]
159}160161#[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! {
162/// The `forbidden_lint_groups` lint detects violations of
163 /// `forbid` applied to a lint group. Due to a bug in the compiler,
164 /// these used to be overlooked entirely. They now generate a warning.
165 ///
166 /// ### Example
167 ///
168 /// ```rust
169 /// #![forbid(warnings)]
170 /// #![warn(bad_style)]
171 ///
172 /// fn main() {}
173 /// ```
174 ///
175 /// {{produces}}
176 ///
177 /// ### Recommended fix
178 ///
179 /// If your crate is using `#![forbid(warnings)]`,
180 /// we recommend that you change to `#![deny(warnings)]`.
181 ///
182 /// ### Explanation
183 ///
184 /// Due to a compiler bug, applying `forbid` to lint groups
185 /// previously had no effect. The bug is now fixed but instead of
186 /// enforcing `forbid` we issue this future-compatibility warning
187 /// to avoid breaking existing crates.
188pub FORBIDDEN_LINT_GROUPS,
189 Warn,
190"applying forbid to lint-groups",
191 @future_incompatible = FutureIncompatibleInfo {
192 reason: fcw!(FutureReleaseError #81670),
193 report_in_deps: true,
194 };
195}196197#[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! {
198/// The `ill_formed_attribute_input` lint detects ill-formed attribute
199 /// inputs that were previously accepted and used in practice.
200 ///
201 /// ### Example
202 ///
203 /// ```rust,compile_fail
204 /// #[inline = "this is not valid"]
205 /// fn foo() {}
206 /// ```
207 ///
208 /// {{produces}}
209 ///
210 /// ### Explanation
211 ///
212 /// Previously, inputs for many built-in attributes weren't validated and
213 /// nonsensical attribute inputs were accepted. After validation was
214 /// added, it was determined that some existing projects made use of these
215 /// invalid forms. This is a [future-incompatible] lint to transition this
216 /// to a hard error in the future. See [issue #57571] for more details.
217 ///
218 /// Check the [attribute reference] for details on the valid inputs for
219 /// attributes.
220 ///
221 /// [issue #57571]: https://github.com/rust-lang/rust/issues/57571
222 /// [attribute reference]: https://doc.rust-lang.org/nightly/reference/attributes.html
223 /// [future-incompatible]: ../index.md#future-incompatible-lints
224pub ILL_FORMED_ATTRIBUTE_INPUT,
225 Deny,
226"ill-formed attribute inputs that were previously accepted and used in practice",
227 @future_incompatible = FutureIncompatibleInfo {
228 reason: fcw!(FutureReleaseError #57571),
229 report_in_deps: true,
230 };
231 crate_level_only
232}233234#[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! {
235/// The `conflicting_repr_hints` lint detects [`repr` attributes] with
236 /// conflicting hints.
237 ///
238 /// [`repr` attributes]: https://doc.rust-lang.org/reference/type-layout.html#representations
239 ///
240 /// ### Example
241 ///
242 /// ```rust,compile_fail
243 /// #[repr(u32, u64)]
244 /// enum Foo {
245 /// Variant1,
246 /// }
247 /// ```
248 ///
249 /// {{produces}}
250 ///
251 /// ### Explanation
252 ///
253 /// The compiler incorrectly accepted these conflicting representations in
254 /// the past. This is a [future-incompatible] lint to transition this to a
255 /// hard error in the future. See [issue #68585] for more details.
256 ///
257 /// To correct the issue, remove one of the conflicting hints.
258 ///
259 /// [issue #68585]: https://github.com/rust-lang/rust/issues/68585
260 /// [future-incompatible]: ../index.md#future-incompatible-lints
261pub CONFLICTING_REPR_HINTS,
262 Deny,
263"conflicts between `#[repr(..)]` hints that were previously accepted and used in practice",
264 @future_incompatible = FutureIncompatibleInfo {
265 reason: fcw!(FutureReleaseError #68585),
266 report_in_deps: true,
267 };
268}269270#[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! {
271/// The `meta_variable_misuse` lint detects possible meta-variable misuse
272 /// in macro definitions.
273 ///
274 /// ### Example
275 ///
276 /// ```rust,compile_fail
277 /// #![deny(meta_variable_misuse)]
278 ///
279 /// macro_rules! foo {
280 /// () => {};
281 /// ($( $i:ident = $($j:ident),+ );*) => { $( $( $i = $k; )+ )* };
282 /// }
283 ///
284 /// fn main() {
285 /// foo!();
286 /// }
287 /// ```
288 ///
289 /// {{produces}}
290 ///
291 /// ### Explanation
292 ///
293 /// There are quite a few different ways a [`macro_rules`] macro can be
294 /// improperly defined. Many of these errors were previously only detected
295 /// when the macro was expanded or not at all. This lint is an attempt to
296 /// catch some of these problems when the macro is *defined*.
297 ///
298 /// This lint is "allow" by default because it may have false positives
299 /// and other issues. See [issue #61053] for more details.
300 ///
301 /// [`macro_rules`]: https://doc.rust-lang.org/reference/macros-by-example.html
302 /// [issue #61053]: https://github.com/rust-lang/rust/issues/61053
303pub META_VARIABLE_MISUSE,
304 Allow,
305"possible meta-variable misuse at macro definition"
306}307308#[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! {
309/// The `incomplete_include` lint detects the use of the [`include!`]
310 /// macro with a file that contains more than one expression.
311 ///
312 /// [`include!`]: https://doc.rust-lang.org/std/macro.include.html
313 ///
314 /// ### Example
315 ///
316 /// ```rust,ignore (needs separate file)
317 /// fn main() {
318 /// include!("foo.txt");
319 /// }
320 /// ```
321 ///
322 /// where the file `foo.txt` contains:
323 ///
324 /// ```text
325 /// println!("hi!");
326 /// ```
327 ///
328 /// produces:
329 ///
330 /// ```text
331 /// error: include macro expected single expression in source
332 /// --> foo.txt:1:14
333 /// |
334 /// 1 | println!("1");
335 /// | ^
336 /// |
337 /// = note: `#[deny(incomplete_include)]` on by default
338 /// ```
339 ///
340 /// ### Explanation
341 ///
342 /// The [`include!`] macro is currently only intended to be used to
343 /// include a single [expression] or multiple [items]. Historically it
344 /// would ignore any contents after the first expression, but that can be
345 /// confusing. In the example above, the `println!` expression ends just
346 /// before the semicolon, making the semicolon "extra" information that is
347 /// ignored. Perhaps even more surprising, if the included file had
348 /// multiple print statements, the subsequent ones would be ignored!
349 ///
350 /// One workaround is to place the contents in braces to create a [block
351 /// expression]. Also consider alternatives, like using functions to
352 /// encapsulate the expressions, or use [proc-macros].
353 ///
354 /// This is a lint instead of a hard error because existing projects were
355 /// found to hit this error. To be cautious, it is a lint for now. The
356 /// future semantics of the `include!` macro are also uncertain, see
357 /// [issue #35560].
358 ///
359 /// [items]: https://doc.rust-lang.org/reference/items.html
360 /// [expression]: https://doc.rust-lang.org/reference/expressions.html
361 /// [block expression]: https://doc.rust-lang.org/reference/expressions/block-expr.html
362 /// [proc-macros]: https://doc.rust-lang.org/reference/procedural-macros.html
363 /// [issue #35560]: https://github.com/rust-lang/rust/issues/35560
364pub INCOMPLETE_INCLUDE,
365 Deny,
366"trailing content in included file"
367}368369#[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! {
370/// The `arithmetic_overflow` lint detects that an arithmetic operation
371 /// will [overflow].
372 ///
373 /// [overflow]: https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow
374 ///
375 /// ### Example
376 ///
377 /// ```rust,compile_fail
378 /// 1_i32 << 32;
379 /// ```
380 ///
381 /// {{produces}}
382 ///
383 /// ### Explanation
384 ///
385 /// It is very likely a mistake to perform an arithmetic operation that
386 /// overflows its value. If the compiler is able to detect these kinds of
387 /// overflows at compile-time, it will trigger this lint. Consider
388 /// adjusting the expression to avoid overflow, or use a data type that
389 /// will not overflow.
390pub ARITHMETIC_OVERFLOW,
391 Deny,
392"arithmetic operation overflows",
393 @eval_always = true
394}395396#[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! {
397/// The `unconditional_panic` lint detects an operation that will cause a
398 /// panic at runtime.
399 ///
400 /// ### Example
401 ///
402 /// ```rust,compile_fail
403 /// # #![allow(unused)]
404 /// let x = 1 / 0;
405 /// ```
406 ///
407 /// {{produces}}
408 ///
409 /// ### Explanation
410 ///
411 /// This lint detects code that is very likely incorrect because it will
412 /// always panic, such as division by zero and out-of-bounds array
413 /// accesses. Consider adjusting your code if this is a bug, or using the
414 /// `panic!` or `unreachable!` macro instead in case the panic is intended.
415pub UNCONDITIONAL_PANIC,
416 Deny,
417"operation will cause a panic at runtime",
418 @eval_always = true
419}420421#[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! {
422/// The `unused_imports` lint detects imports that are never used.
423 ///
424 /// ### Example
425 ///
426 /// ```rust
427 /// use std::collections::HashMap;
428 /// ```
429 ///
430 /// {{produces}}
431 ///
432 /// ### Explanation
433 ///
434 /// Unused imports may signal a mistake or unfinished code, and clutter
435 /// the code, and should be removed. If you intended to re-export the item
436 /// to make it available outside of the module, add a visibility modifier
437 /// like `pub`.
438pub UNUSED_IMPORTS,
439 Warn,
440"imports that are never used"
441}442443#[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! {
444/// The `redundant_imports` lint detects imports that are redundant due to being
445 /// imported already; either through a previous import, or being present in
446 /// the prelude.
447 ///
448 /// ### Example
449 ///
450 /// ```rust,compile_fail
451 /// #![deny(redundant_imports)]
452 /// use std::option::Option::None;
453 /// fn foo() -> Option<i32> { None }
454 /// ```
455 ///
456 /// {{produces}}
457 ///
458 /// ### Explanation
459 ///
460 /// Redundant imports are unnecessary and can be removed to simplify code.
461 /// If you intended to re-export the item to make it available outside of the
462 /// module, add a visibility modifier like `pub`.
463pub REDUNDANT_IMPORTS,
464 Allow,
465"imports that are redundant due to being imported already"
466}467468#[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! {
469/// The `must_not_suspend` lint guards against values that shouldn't be held across suspend points
470 /// (`.await`)
471 ///
472 /// ### Example
473 ///
474 /// ```rust
475 /// #![feature(must_not_suspend)]
476 /// #![warn(must_not_suspend)]
477 ///
478 /// #[must_not_suspend]
479 /// struct SyncThing {}
480 ///
481 /// async fn yield_now() {}
482 ///
483 /// pub async fn uhoh() {
484 /// let guard = SyncThing {};
485 /// yield_now().await;
486 /// let _guard = guard;
487 /// }
488 /// ```
489 ///
490 /// {{produces}}
491 ///
492 /// ### Explanation
493 ///
494 /// The `must_not_suspend` lint detects values that are marked with the `#[must_not_suspend]`
495 /// attribute being held across suspend points. A "suspend" point is usually a `.await` in an async
496 /// function.
497 ///
498 /// This attribute can be used to mark values that are semantically incorrect across suspends
499 /// (like certain types of timers), values that have async alternatives, and values that
500 /// regularly cause problems with the `Send`-ness of async fn's returned futures (like
501 /// `MutexGuard`'s)
502 ///
503pub MUST_NOT_SUSPEND,
504 Allow,
505"use of a `#[must_not_suspend]` value across a yield point",
506 @feature_gate = must_not_suspend;
507}508509#[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! {
510/// The `unused_extern_crates` lint guards against `extern crate` items
511 /// that are never used.
512 ///
513 /// ### Example
514 ///
515 /// ```rust,compile_fail
516 /// #![deny(unused_extern_crates)]
517 /// #![deny(warnings)]
518 /// extern crate proc_macro;
519 /// ```
520 ///
521 /// {{produces}}
522 ///
523 /// ### Explanation
524 ///
525 /// `extern crate` items that are unused have no effect and should be
526 /// removed. Note that there are some cases where specifying an `extern
527 /// crate` is desired for the side effect of ensuring the given crate is
528 /// linked, even though it is not otherwise directly referenced. The lint
529 /// can be silenced by aliasing the crate to an underscore, such as
530 /// `extern crate foo as _`. Also note that it is no longer idiomatic to
531 /// use `extern crate` in the [2018 edition], as extern crates are now
532 /// automatically added in scope.
533 ///
534 /// This lint is "allow" by default because it can be noisy, and produce
535 /// false-positives. If a dependency is being removed from a project, it
536 /// is recommended to remove it from the build configuration (such as
537 /// `Cargo.toml`) to ensure stale build entries aren't left behind.
538 ///
539 /// [2018 edition]: https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-clarity.html#no-more-extern-crate
540pub UNUSED_EXTERN_CRATES,
541 Allow,
542"extern crates that are never used"
543}544545#[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! {
546/// The `unused_crate_dependencies` lint detects crate dependencies that
547 /// are never used.
548 ///
549 /// ### Example
550 ///
551 /// ```rust,ignore (needs extern crate)
552 /// #![deny(unused_crate_dependencies)]
553 /// ```
554 ///
555 /// This will produce:
556 ///
557 /// ```text
558 /// error: extern crate `regex` is unused in crate `lint_example`
559 /// |
560 /// = help: remove the dependency or add `use regex as _;` to the crate root
561 /// note: the lint level is defined here
562 /// --> src/lib.rs:1:9
563 /// |
564 /// 1 | #![deny(unused_crate_dependencies)]
565 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^
566 /// ```
567 ///
568 /// ### Explanation
569 ///
570 /// After removing the code that uses a dependency, this usually also
571 /// requires removing the dependency from the build configuration.
572 /// However, sometimes that step can be missed, which leads to time wasted
573 /// building dependencies that are no longer used. This lint can be
574 /// enabled to detect dependencies that are never used (more specifically,
575 /// any dependency passed with the `--extern` command-line flag that is
576 /// never referenced via [`use`], [`extern crate`], or in any [path]).
577 ///
578 /// This lint is "allow" by default because it can provide false positives
579 /// depending on how the build system is configured. For example, when
580 /// using Cargo, a "package" consists of multiple crates (such as a
581 /// library and a binary), but the dependencies are defined for the
582 /// package as a whole. If there is a dependency that is only used in the
583 /// binary, but not the library, then the lint will be incorrectly issued
584 /// in the library.
585 ///
586 /// [path]: https://doc.rust-lang.org/reference/paths.html
587 /// [`use`]: https://doc.rust-lang.org/reference/items/use-declarations.html
588 /// [`extern crate`]: https://doc.rust-lang.org/reference/items/extern-crates.html
589pub UNUSED_CRATE_DEPENDENCIES,
590 Allow,
591"crate dependencies that are never used",
592 crate_level_only
593}594595#[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! {
596/// The `unused_qualifications` lint detects unnecessarily qualified
597 /// names.
598 ///
599 /// ### Example
600 ///
601 /// ```rust,compile_fail
602 /// #![deny(unused_qualifications)]
603 /// mod foo {
604 /// pub fn bar() {}
605 /// }
606 ///
607 /// fn main() {
608 /// use foo::bar;
609 /// foo::bar();
610 /// bar();
611 /// }
612 /// ```
613 ///
614 /// {{produces}}
615 ///
616 /// ### Explanation
617 ///
618 /// If an item from another module is already brought into scope, then
619 /// there is no need to qualify it in this case. You can call `bar()`
620 /// directly, without the `foo::`.
621 ///
622 /// This lint is "allow" by default because it is somewhat pedantic, and
623 /// doesn't indicate an actual problem, but rather a stylistic choice, and
624 /// can be noisy when refactoring or moving around code.
625pub UNUSED_QUALIFICATIONS,
626 Allow,
627"detects unnecessarily qualified names"
628}629630#[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! {
631/// The `unknown_lints` lint detects unrecognized lint attributes.
632 ///
633 /// ### Example
634 ///
635 /// ```rust
636 /// #![allow(not_a_real_lint)]
637 /// ```
638 ///
639 /// {{produces}}
640 ///
641 /// ### Explanation
642 ///
643 /// It is usually a mistake to specify a lint that does not exist. Check
644 /// the spelling, and check the lint listing for the correct name. Also
645 /// consider if you are using an old version of the compiler, and the lint
646 /// is only available in a newer version.
647pub UNKNOWN_LINTS,
648 Warn,
649"unrecognized lint attribute",
650 @eval_always = true
651}652653#[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! {
654/// The `unfulfilled_lint_expectations` lint detects when a lint expectation is
655 /// unfulfilled.
656 ///
657 /// ### Example
658 ///
659 /// ```rust
660 /// #[expect(unused_variables)]
661 /// let x = 10;
662 /// println!("{}", x);
663 /// ```
664 ///
665 /// {{produces}}
666 ///
667 /// ### Explanation
668 ///
669 /// The `#[expect]` attribute can be used to create a lint expectation. The
670 /// expectation is fulfilled, if a `#[warn]` attribute at the same location
671 /// would result in a lint emission. If the expectation is unfulfilled,
672 /// because no lint was emitted, this lint will be emitted on the attribute.
673 ///
674pub UNFULFILLED_LINT_EXPECTATIONS,
675 Warn,
676"unfulfilled lint expectation"
677}678679#[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! {
680/// The `unused_variables` lint detects variables which are not used in
681 /// any way.
682 ///
683 /// ### Example
684 ///
685 /// ```rust
686 /// let x = 5;
687 /// ```
688 ///
689 /// {{produces}}
690 ///
691 /// ### Explanation
692 ///
693 /// Unused variables may signal a mistake or unfinished code. To silence
694 /// the warning for the individual variable, prefix it with an underscore
695 /// such as `_x`.
696pub UNUSED_VARIABLES,
697 Warn,
698"detect variables which are not used in any way"
699}700701#[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! {
702/// The `unused_visibilities` lint detects visibility qualifiers (like `pub`)
703 /// on a `const _` item.
704 ///
705 /// ### Example
706 ///
707 /// ```rust
708 /// pub const _: () = {};
709 /// ```
710 ///
711 /// {{produces}}
712 ///
713 /// ### Explanation
714 ///
715 /// These qualifiers have no effect, as `const _` items are unnameable.
716pub UNUSED_VISIBILITIES,
717 Warn,
718"detect visibility qualifiers on `const _` items"
719}720721#[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! {
722/// The `unused_assignments` lint detects assignments that will never be read.
723 ///
724 /// ### Example
725 ///
726 /// ```rust
727 /// let mut x = 5;
728 /// x = 6;
729 /// ```
730 ///
731 /// {{produces}}
732 ///
733 /// ### Explanation
734 ///
735 /// Unused assignments may signal a mistake or unfinished code. If the
736 /// variable is never used after being assigned, then the assignment can
737 /// be removed. Variables with an underscore prefix such as `_x` will not
738 /// trigger this lint.
739pub UNUSED_ASSIGNMENTS,
740 Warn,
741"detect assignments that will never be read"
742}743744#[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! {
745/// The `dead_code` lint detects unused, unexported items.
746 ///
747 /// ### Example
748 ///
749 /// ```rust
750 /// fn foo() {}
751 /// ```
752 ///
753 /// {{produces}}
754 ///
755 /// ### Explanation
756 ///
757 /// Dead code may signal a mistake or unfinished code. To silence the
758 /// warning for individual items, prefix the name with an underscore such
759 /// as `_foo`. If it was intended to expose the item outside of the crate,
760 /// consider adding a visibility modifier like `pub`.
761 ///
762 /// To preserve the numbering of tuple structs with unused fields,
763 /// change the unused fields to have unit type or use
764 /// `PhantomData`.
765 ///
766 /// Otherwise consider removing the unused code.
767 ///
768 /// ### Limitations
769 ///
770 /// Removing fields that are only used for side-effects and never
771 /// read will result in behavioral changes. Examples of this
772 /// include:
773 ///
774 /// - If a field's value performs an action when it is dropped.
775 /// - If a field's type does not implement an auto trait
776 /// (e.g. `Send`, `Sync`, `Unpin`).
777 ///
778 /// For side-effects from dropping field values, this lint should
779 /// be allowed on those fields. For side-effects from containing
780 /// field types, `PhantomData` should be used.
781pub DEAD_CODE,
782 Warn,
783"detect unused, unexported items"
784}785786#[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! {
787/// The `unused_attributes` lint detects attributes that were not used by
788 /// the compiler.
789 ///
790 /// ### Example
791 ///
792 /// ```rust
793 /// #![ignore]
794 /// ```
795 ///
796 /// {{produces}}
797 ///
798 /// ### Explanation
799 ///
800 /// Unused [attributes] may indicate the attribute is placed in the wrong
801 /// position. Consider removing it, or placing it in the correct position.
802 /// Also consider if you intended to use an _inner attribute_ (with a `!`
803 /// such as `#![allow(unused)]`) which applies to the item the attribute
804 /// is within, or an _outer attribute_ (without a `!` such as
805 /// `#[allow(unused)]`) which applies to the item *following* the
806 /// attribute.
807 ///
808 /// [attributes]: https://doc.rust-lang.org/reference/attributes.html
809pub UNUSED_ATTRIBUTES,
810 Warn,
811"detects attributes that were not used by the compiler"
812}813814#[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! {
815/// The `unreachable_code` lint detects unreachable code paths.
816 ///
817 /// ### Example
818 ///
819 /// ```rust,no_run
820 /// panic!("we never go past here!");
821 ///
822 /// let x = 5;
823 /// ```
824 ///
825 /// {{produces}}
826 ///
827 /// ### Explanation
828 ///
829 /// Unreachable code may signal a mistake or unfinished code. If the code
830 /// is no longer in use, consider removing it.
831pub UNREACHABLE_CODE,
832 Warn,
833"detects unreachable code paths",
834 report_in_external_macro
835}836837#[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! {
838/// The `unreachable_patterns` lint detects unreachable patterns.
839 ///
840 /// ### Example
841 ///
842 /// ```rust
843 /// let x = 5;
844 /// match x {
845 /// y => (),
846 /// 5 => (),
847 /// }
848 /// ```
849 ///
850 /// {{produces}}
851 ///
852 /// ### Explanation
853 ///
854 /// This usually indicates a mistake in how the patterns are specified or
855 /// ordered. In this example, the `y` pattern will always match, so the
856 /// five is impossible to reach. Remember, match arms match in order, you
857 /// probably wanted to put the `5` case above the `y` case.
858pub UNREACHABLE_PATTERNS,
859 Warn,
860"detects unreachable patterns"
861}862863#[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" 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,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
864/// The `unreachable_cfg_select_predicates` lint detects unreachable configuration
865 /// predicates in the `cfg_select!` macro.
866 ///
867 /// ### Example
868 ///
869 /// ```rust
870 /// cfg_select! {
871 /// _ => (),
872 /// windows => (),
873 /// }
874 /// ```
875 ///
876 /// {{produces}}
877 ///
878 /// ### Explanation
879 ///
880 /// This usually indicates a mistake in how the predicates are specified or
881 /// ordered. In this example, the `_` predicate will always match, so the
882 /// `windows` is impossible to reach. Remember, arms match in order, you
883 /// probably wanted to put the `windows` case above the `_` case.
884pub UNREACHABLE_CFG_SELECT_PREDICATES,
885 Warn,
886"detects unreachable configuration predicates in the cfg_select macro",
887}888889#[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! {
890/// The `overlapping_range_endpoints` lint detects `match` arms that have [range patterns] that
891 /// overlap on their endpoints.
892 ///
893 /// [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns
894 ///
895 /// ### Example
896 ///
897 /// ```rust
898 /// let x = 123u8;
899 /// match x {
900 /// 0..=100 => { println!("small"); }
901 /// 100..=255 => { println!("large"); }
902 /// }
903 /// ```
904 ///
905 /// {{produces}}
906 ///
907 /// ### Explanation
908 ///
909 /// It is likely a mistake to have range patterns in a match expression that overlap in this
910 /// way. Check that the beginning and end values are what you expect, and keep in mind that
911 /// with `..=` the left and right bounds are inclusive.
912pub OVERLAPPING_RANGE_ENDPOINTS,
913 Warn,
914"detects range patterns with overlapping endpoints"
915}916917#[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! {
918/// The `non_contiguous_range_endpoints` lint detects likely off-by-one errors when using
919 /// exclusive [range patterns].
920 ///
921 /// [range patterns]: https://doc.rust-lang.org/nightly/reference/patterns.html#range-patterns
922 ///
923 /// ### Example
924 ///
925 /// ```rust
926 /// let x = 123u32;
927 /// match x {
928 /// 0..100 => { println!("small"); }
929 /// 101..1000 => { println!("large"); }
930 /// _ => { println!("larger"); }
931 /// }
932 /// ```
933 ///
934 /// {{produces}}
935 ///
936 /// ### Explanation
937 ///
938 /// It is likely a mistake to have range patterns in a match expression that miss out a single
939 /// number. Check that the beginning and end values are what you expect, and keep in mind that
940 /// with `..=` the right bound is inclusive, and with `..` it is exclusive.
941pub NON_CONTIGUOUS_RANGE_ENDPOINTS,
942 Warn,
943"detects off-by-one errors with exclusive range patterns"
944}945946#[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! {
947/// The `bindings_with_variant_name` lint detects pattern bindings with
948 /// the same name as one of the matched variants.
949 ///
950 /// ### Example
951 ///
952 /// ```rust,compile_fail
953 /// pub enum Enum {
954 /// Foo,
955 /// Bar,
956 /// }
957 ///
958 /// pub fn foo(x: Enum) {
959 /// match x {
960 /// Foo => {}
961 /// Bar => {}
962 /// }
963 /// }
964 /// ```
965 ///
966 /// {{produces}}
967 ///
968 /// ### Explanation
969 ///
970 /// It is usually a mistake to specify an enum variant name as an
971 /// [identifier pattern]. In the example above, the `match` arms are
972 /// specifying a variable name to bind the value of `x` to. The second arm
973 /// is ignored because the first one matches *all* values. The likely
974 /// intent is that the arm was intended to match on the enum variant.
975 ///
976 /// Two possible solutions are:
977 ///
978 /// * Specify the enum variant using a [path pattern], such as
979 /// `Enum::Foo`.
980 /// * Bring the enum variants into local scope, such as adding `use
981 /// Enum::*;` to the beginning of the `foo` function in the example
982 /// above.
983 ///
984 /// [identifier pattern]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
985 /// [path pattern]: https://doc.rust-lang.org/reference/patterns.html#path-patterns
986pub BINDINGS_WITH_VARIANT_NAME,
987 Deny,
988"detects pattern bindings with the same name as one of the matched variants"
989}990991#[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! {
992/// The `unused_macros` lint detects macros that were not used.
993 ///
994 /// Note that this lint is distinct from the `unused_macro_rules` lint,
995 /// which checks for single rules that never match of an otherwise used
996 /// macro, and thus never expand.
997 ///
998 /// ### Example
999 ///
1000 /// ```rust
1001 /// macro_rules! unused {
1002 /// () => {};
1003 /// }
1004 ///
1005 /// fn main() {
1006 /// }
1007 /// ```
1008 ///
1009 /// {{produces}}
1010 ///
1011 /// ### Explanation
1012 ///
1013 /// Unused macros may signal a mistake or unfinished code. To silence the
1014 /// warning for the individual macro, prefix the name with an underscore
1015 /// such as `_my_macro`. If you intended to export the macro to make it
1016 /// available outside of the crate, use the [`macro_export` attribute].
1017 ///
1018 /// [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
1019pub UNUSED_MACROS,
1020 Warn,
1021"detects macros that were not used"
1022}10231024#[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 used"#]
#[doc = r#" () => { println!("empty") }; // This rule is unused"#]
#[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! {
1025/// The `unused_macro_rules` lint detects macro rules that were not used.
1026 ///
1027 /// Note that the lint is distinct from the `unused_macros` lint, which
1028 /// fires if the entire macro is never called, while this lint fires for
1029 /// single unused rules of the macro that is otherwise used.
1030 /// `unused_macro_rules` fires only if `unused_macros` wouldn't fire.
1031 ///
1032 /// ### Example
1033 ///
1034 /// ```rust
1035 /// #[warn(unused_macro_rules)]
1036 /// macro_rules! unused_empty {
1037 /// (hello) => { println!("Hello, world!") }; // This rule is used
1038 /// () => { println!("empty") }; // This rule is unused
1039 /// }
1040 ///
1041 /// fn main() {
1042 /// unused_empty!(hello);
1043 /// }
1044 /// ```
1045 ///
1046 /// {{produces}}
1047 ///
1048 /// ### Explanation
1049 ///
1050 /// Unused macro rules may signal a mistake or unfinished code. Furthermore,
1051 /// they slow down compilation. Right now, silencing the warning is not
1052 /// supported on a single rule level, so you have to add an allow to the
1053 /// entire macro definition.
1054 ///
1055 /// If you intended to export the macro to make it
1056 /// available outside of the crate, use the [`macro_export` attribute].
1057 ///
1058 /// [`macro_export` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
1059pub UNUSED_MACRO_RULES,
1060 Allow,
1061"detects macro rules that were not used"
1062}10631064#[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! {
1065/// The `warnings` lint allows you to change the level of other
1066 /// lints which produce warnings.
1067 ///
1068 /// ### Example
1069 ///
1070 /// ```rust
1071 /// #![deny(warnings)]
1072 /// fn foo() {}
1073 /// ```
1074 ///
1075 /// {{produces}}
1076 ///
1077 /// ### Explanation
1078 ///
1079 /// The `warnings` lint is a bit special; by changing its level, you
1080 /// change every other warning that would produce a warning to whatever
1081 /// value you'd like. As such, you won't ever trigger this lint in your
1082 /// code directly.
1083pub WARNINGS,
1084 Warn,
1085"mass-change the level for lints which produce warnings"
1086}10871088#[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/"]
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! {
1089/// The `unused_features` lint detects unused or unknown features found in
1090 /// crate-level [`feature` attributes].
1091 ///
1092 /// [`feature` attributes]: https://doc.rust-lang.org/nightly/unstable-book/
1093pub UNUSED_FEATURES,
1094 Warn,
1095"unused features found in crate-level `#[feature]` directives"
1096}10971098#[doc = r" The `duplicate_features` lint detects duplicate features found in"]
#[doc = r" crate-level [`feature` attributes]."]
#[doc = r""]
#[doc = r" Note: This lint used to be a hard error (E0636)."]
#[doc = r""]
#[doc =
r" [`feature` attributes]: https://doc.rust-lang.org/nightly/unstable-book/"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[doc = r" # #![allow(internal_features)]"]
#[doc = r" #![feature(rustc_attrs)]"]
#[doc = r" #![feature(rustc_attrs)]"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" Enabling a feature more than once is a no-op."]
#[doc = r" To avoid this warning, remove the second `feature()` attribute."]
pub static DUPLICATE_FEATURES: &crate::Lint =
&crate::Lint {
name: "DUPLICATE_FEATURES",
default_level: crate::Deny,
desc: "duplicate features found in crate-level `#[feature]` directives",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
1099/// The `duplicate_features` lint detects duplicate features found in
1100 /// crate-level [`feature` attributes].
1101 ///
1102 /// Note: This lint used to be a hard error (E0636).
1103 ///
1104 /// [`feature` attributes]: https://doc.rust-lang.org/nightly/unstable-book/
1105 ///
1106 /// ### Example
1107 ///
1108 /// ```rust,compile_fail
1109 /// # #![allow(internal_features)]
1110 /// #![feature(rustc_attrs)]
1111 /// #![feature(rustc_attrs)]
1112 /// ```
1113 ///
1114 /// {{produces}}
1115 ///
1116 /// ### Explanation
1117 ///
1118 /// Enabling a feature more than once is a no-op.
1119 /// To avoid this warning, remove the second `feature()` attribute.
1120pub DUPLICATE_FEATURES,
1121 Deny,
1122"duplicate features found in crate-level `#[feature]` directives"
1123}11241125#[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! {
1126/// The `stable_features` lint detects a [`feature` attribute] that
1127 /// has since been made stable.
1128 ///
1129 /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
1130 ///
1131 /// ### Example
1132 ///
1133 /// ```rust
1134 /// #![feature(test_accepted_feature)]
1135 /// fn main() {}
1136 /// ```
1137 ///
1138 /// {{produces}}
1139 ///
1140 /// ### Explanation
1141 ///
1142 /// When a feature is stabilized, it is no longer necessary to include a
1143 /// `#![feature]` attribute for it. To fix, simply remove the
1144 /// `#![feature]` attribute.
1145pub STABLE_FEATURES,
1146 Warn,
1147"stable features found in `#[feature]` directive"
1148}11491150#[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! {
1151/// The `unknown_crate_types` lint detects an unknown crate type found in
1152 /// a [`crate_type` attribute].
1153 ///
1154 /// ### Example
1155 ///
1156 /// ```rust,compile_fail
1157 /// #![crate_type="lol"]
1158 /// fn main() {}
1159 /// ```
1160 ///
1161 /// {{produces}}
1162 ///
1163 /// ### Explanation
1164 ///
1165 /// An unknown value give to the `crate_type` attribute is almost
1166 /// certainly a mistake.
1167 ///
1168 /// [`crate_type` attribute]: https://doc.rust-lang.org/reference/linkage.html
1169pub UNKNOWN_CRATE_TYPES,
1170 Deny,
1171"unknown crate type found in `#[crate_type]` directive",
1172 crate_level_only
1173}11741175#[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! {
1176/// The `trivial_casts` lint detects trivial casts which could be replaced
1177 /// with coercion, which may require a temporary variable.
1178 ///
1179 /// ### Example
1180 ///
1181 /// ```rust,compile_fail
1182 /// #![deny(trivial_casts)]
1183 /// let x: &u32 = &42;
1184 /// let y = x as *const u32;
1185 /// ```
1186 ///
1187 /// {{produces}}
1188 ///
1189 /// ### Explanation
1190 ///
1191 /// A trivial cast is a cast `e as T` where `e` has type `U` and `U` is a
1192 /// subtype of `T`. This type of cast is usually unnecessary, as it can be
1193 /// usually be inferred.
1194 ///
1195 /// This lint is "allow" by default because there are situations, such as
1196 /// with FFI interfaces or complex type aliases, where it triggers
1197 /// incorrectly, or in situations where it will be more difficult to
1198 /// clearly express the intent. It may be possible that this will become a
1199 /// warning in the future, possibly with an explicit syntax for coercions
1200 /// providing a convenient way to work around the current issues.
1201 /// See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and
1202 /// [RFC 3307 (remove type ascription)][rfc-3307] for historical context.
1203 ///
1204 /// [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
1205 /// [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md
1206 /// [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md
1207pub TRIVIAL_CASTS,
1208 Allow,
1209"detects trivial casts which could be removed"
1210}12111212#[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! {
1213/// The `trivial_numeric_casts` lint detects trivial numeric casts of types
1214 /// which could be removed.
1215 ///
1216 /// ### Example
1217 ///
1218 /// ```rust,compile_fail
1219 /// #![deny(trivial_numeric_casts)]
1220 /// let x = 42_i32 as i32;
1221 /// ```
1222 ///
1223 /// {{produces}}
1224 ///
1225 /// ### Explanation
1226 ///
1227 /// A trivial numeric cast is a cast of a numeric type to the same numeric
1228 /// type. This type of cast is usually unnecessary.
1229 ///
1230 /// This lint is "allow" by default because there are situations, such as
1231 /// with FFI interfaces or complex type aliases, where it triggers
1232 /// incorrectly, or in situations where it will be more difficult to
1233 /// clearly express the intent. It may be possible that this will become a
1234 /// warning in the future, possibly with an explicit syntax for coercions
1235 /// providing a convenient way to work around the current issues.
1236 /// See [RFC 401 (coercions)][rfc-401], [RFC 803 (type ascription)][rfc-803] and
1237 /// [RFC 3307 (remove type ascription)][rfc-3307] for historical context.
1238 ///
1239 /// [rfc-401]: https://github.com/rust-lang/rfcs/blob/master/text/0401-coercions.md
1240 /// [rfc-803]: https://github.com/rust-lang/rfcs/blob/master/text/0803-type-ascription.md
1241 /// [rfc-3307]: https://github.com/rust-lang/rfcs/blob/master/text/3307-de-rfc-type-ascription.md
1242pub TRIVIAL_NUMERIC_CASTS,
1243 Allow,
1244"detects trivial casts of numeric types which could be removed"
1245}12461247#[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! {
1248/// The `exported_private_dependencies` lint detects private dependencies
1249 /// that are exposed in a public interface.
1250 ///
1251 /// ### Example
1252 ///
1253 /// ```rust,ignore (needs-dependency)
1254 /// pub fn foo() -> Option<some_private_dependency::Thing> {
1255 /// None
1256 /// }
1257 /// ```
1258 ///
1259 /// This will produce:
1260 ///
1261 /// ```text
1262 /// warning: type `bar::Thing` from private dependency 'bar' in public interface
1263 /// --> src/lib.rs:3:1
1264 /// |
1265 /// 3 | pub fn foo() -> Option<bar::Thing> {
1266 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1267 /// |
1268 /// = note: `#[warn(exported_private_dependencies)]` on by default
1269 /// ```
1270 ///
1271 /// ### Explanation
1272 ///
1273 /// Dependencies can be marked as "private" to indicate that they are not
1274 /// exposed in the public interface of a crate. This can be used by Cargo
1275 /// to independently resolve those dependencies because it can assume it
1276 /// does not need to unify them with other packages using that same
1277 /// dependency. This lint is an indication of a violation of that
1278 /// contract.
1279 ///
1280 /// To fix this, avoid exposing the dependency in your public interface.
1281 /// Or, switch the dependency to a public dependency.
1282 ///
1283 /// Note that support for this is only available on the nightly channel.
1284 /// See [RFC 1977] for more details, as well as the [Cargo documentation].
1285 ///
1286 /// [RFC 1977]: https://github.com/rust-lang/rfcs/blob/master/text/1977-public-private-dependencies.md
1287 /// [Cargo documentation]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#public-dependency
1288pub EXPORTED_PRIVATE_DEPENDENCIES,
1289 Warn,
1290"public interface leaks type from a private dependency"
1291}12921293#[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! {
1294/// The `pub_use_of_private_extern_crate` lint detects a specific
1295 /// situation of re-exporting a private `extern crate`.
1296 ///
1297 /// ### Example
1298 ///
1299 /// ```rust,compile_fail
1300 /// extern crate core;
1301 /// pub use core as reexported_core;
1302 /// ```
1303 ///
1304 /// {{produces}}
1305 ///
1306 /// ### Explanation
1307 ///
1308 /// A public `use` declaration should not be used to publically re-export a
1309 /// private `extern crate`. `pub extern crate` should be used instead.
1310 ///
1311 /// This was historically allowed, but is not the intended behavior
1312 /// according to the visibility rules. This is a [future-incompatible]
1313 /// lint to transition this to a hard error in the future. See [issue
1314 /// #127909] for more details.
1315 ///
1316 /// [issue #127909]: https://github.com/rust-lang/rust/issues/127909
1317 /// [future-incompatible]: ../index.md#future-incompatible-lints
1318pub PUB_USE_OF_PRIVATE_EXTERN_CRATE,
1319 Deny,
1320"detect public re-exports of private extern crates",
1321 @future_incompatible = FutureIncompatibleInfo {
1322 reason: fcw!(FutureReleaseError #127909),
1323 report_in_deps: true,
1324 };
1325}13261327#[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! {
1328/// The `invalid_type_param_default` lint detects type parameter defaults
1329 /// erroneously allowed in an invalid location.
1330 ///
1331 /// ### Example
1332 ///
1333 /// ```rust,compile_fail
1334 /// fn foo<T=i32>(t: T) {}
1335 /// ```
1336 ///
1337 /// {{produces}}
1338 ///
1339 /// ### Explanation
1340 ///
1341 /// Default type parameters were only intended to be allowed in certain
1342 /// situations, but historically the compiler allowed them everywhere.
1343 /// This is a [future-incompatible] lint to transition this to a hard
1344 /// error in the future. See [issue #36887] for more details.
1345 ///
1346 /// [issue #36887]: https://github.com/rust-lang/rust/issues/36887
1347 /// [future-incompatible]: ../index.md#future-incompatible-lints
1348pub INVALID_TYPE_PARAM_DEFAULT,
1349 Deny,
1350"type parameter default erroneously allowed in invalid location",
1351 @future_incompatible = FutureIncompatibleInfo {
1352 reason: fcw!(FutureReleaseError #36887),
1353 report_in_deps: true,
1354 };
1355}13561357#[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! {
1358/// The `renamed_and_removed_lints` lint detects lints that have been
1359 /// renamed or removed.
1360 ///
1361 /// ### Example
1362 ///
1363 /// ```rust
1364 /// #![deny(raw_pointer_derive)]
1365 /// ```
1366 ///
1367 /// {{produces}}
1368 ///
1369 /// ### Explanation
1370 ///
1371 /// To fix this, either remove the lint or use the new name. This can help
1372 /// avoid confusion about lints that are no longer valid, and help
1373 /// maintain consistency for renamed lints.
1374pub RENAMED_AND_REMOVED_LINTS,
1375 Warn,
1376"lints that have been renamed or removed"
1377}13781379#[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! {
1380/// The `const_item_mutation` lint detects attempts to mutate a `const`
1381 /// item.
1382 ///
1383 /// ### Example
1384 ///
1385 /// ```rust
1386 /// const FOO: [i32; 1] = [0];
1387 ///
1388 /// fn main() {
1389 /// FOO[0] = 1;
1390 /// // This will print "[0]".
1391 /// println!("{:?}", FOO);
1392 /// }
1393 /// ```
1394 ///
1395 /// {{produces}}
1396 ///
1397 /// ### Explanation
1398 ///
1399 /// Trying to directly mutate a `const` item is almost always a mistake.
1400 /// What is happening in the example above is that a temporary copy of the
1401 /// `const` is mutated, but the original `const` is not. Each time you
1402 /// refer to the `const` by name (such as `FOO` in the example above), a
1403 /// separate copy of the value is inlined at that location.
1404 ///
1405 /// This lint checks for writing directly to a field (`FOO.field =
1406 /// some_value`) or array entry (`FOO[0] = val`), or taking a mutable
1407 /// reference to the const item (`&mut FOO`), including through an
1408 /// autoderef (`FOO.some_mut_self_method()`).
1409 ///
1410 /// There are various alternatives depending on what you are trying to
1411 /// accomplish:
1412 ///
1413 /// * First, always reconsider using mutable globals, as they can be
1414 /// difficult to use correctly, and can make the code more difficult to
1415 /// use or understand.
1416 /// * If you are trying to perform a one-time initialization of a global:
1417 /// * If the value can be computed at compile-time, consider using
1418 /// const-compatible values (see [Constant Evaluation]).
1419 /// * For more complex single-initialization cases, consider using
1420 /// [`std::sync::LazyLock`].
1421 /// * If you truly need a mutable global, consider using a [`static`],
1422 /// which has a variety of options:
1423 /// * Simple data types can be directly defined and mutated with an
1424 /// [`atomic`] type.
1425 /// * More complex types can be placed in a synchronization primitive
1426 /// like a [`Mutex`], which can be initialized with one of the options
1427 /// listed above.
1428 /// * A [mutable `static`] is a low-level primitive, requiring unsafe.
1429 /// Typically This should be avoided in preference of something
1430 /// higher-level like one of the above.
1431 ///
1432 /// [Constant Evaluation]: https://doc.rust-lang.org/reference/const_eval.html
1433 /// [`static`]: https://doc.rust-lang.org/reference/items/static-items.html
1434 /// [mutable `static`]: https://doc.rust-lang.org/reference/items/static-items.html#mutable-statics
1435 /// [`std::sync::LazyLock`]: https://doc.rust-lang.org/stable/std/sync/struct.LazyLock.html
1436 /// [`atomic`]: https://doc.rust-lang.org/std/sync/atomic/index.html
1437 /// [`Mutex`]: https://doc.rust-lang.org/std/sync/struct.Mutex.html
1438pub CONST_ITEM_MUTATION,
1439 Warn,
1440"detects attempts to mutate a `const` item",
1441}14421443#[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! {
1444/// The `patterns_in_fns_without_body` lint detects `mut` identifier
1445 /// patterns as a parameter in functions without a body.
1446 ///
1447 /// ### Example
1448 ///
1449 /// ```rust,compile_fail
1450 /// trait Trait {
1451 /// fn foo(mut arg: u8);
1452 /// }
1453 /// ```
1454 ///
1455 /// {{produces}}
1456 ///
1457 /// ### Explanation
1458 ///
1459 /// To fix this, remove `mut` from the parameter in the trait definition;
1460 /// it can be used in the implementation. That is, the following is OK:
1461 ///
1462 /// ```rust
1463 /// trait Trait {
1464 /// fn foo(arg: u8); // Removed `mut` here
1465 /// }
1466 ///
1467 /// impl Trait for i32 {
1468 /// fn foo(mut arg: u8) { // `mut` here is OK
1469 ///
1470 /// }
1471 /// }
1472 /// ```
1473 ///
1474 /// Trait definitions can define functions without a body to specify a
1475 /// function that implementors must define. The parameter names in the
1476 /// body-less functions are only allowed to be `_` or an [identifier] for
1477 /// documentation purposes (only the type is relevant). Previous versions
1478 /// of the compiler erroneously allowed [identifier patterns] with the
1479 /// `mut` keyword, but this was not intended to be allowed. This is a
1480 /// [future-incompatible] lint to transition this to a hard error in the
1481 /// future. See [issue #35203] for more details.
1482 ///
1483 /// [identifier]: https://doc.rust-lang.org/reference/identifiers.html
1484 /// [identifier patterns]: https://doc.rust-lang.org/reference/patterns.html#identifier-patterns
1485 /// [issue #35203]: https://github.com/rust-lang/rust/issues/35203
1486 /// [future-incompatible]: ../index.md#future-incompatible-lints
1487pub PATTERNS_IN_FNS_WITHOUT_BODY,
1488 Deny,
1489"patterns in functions without body were erroneously allowed",
1490 @future_incompatible = FutureIncompatibleInfo {
1491 reason: fcw!(FutureReleaseError #35203),
1492 };
1493}14941495#[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! {
1496/// The `late_bound_lifetime_arguments` lint detects generic lifetime
1497 /// arguments in path segments with late bound lifetime parameters.
1498 ///
1499 /// ### Example
1500 ///
1501 /// ```rust
1502 /// struct S;
1503 ///
1504 /// impl S {
1505 /// fn late(self, _: &u8, _: &u8) {}
1506 /// }
1507 ///
1508 /// fn main() {
1509 /// S.late::<'static>(&0, &0);
1510 /// }
1511 /// ```
1512 ///
1513 /// {{produces}}
1514 ///
1515 /// ### Explanation
1516 ///
1517 /// It is not clear how to provide arguments for early-bound lifetime
1518 /// parameters if they are intermixed with late-bound parameters in the
1519 /// same list. For now, providing any explicit arguments will trigger this
1520 /// lint if late-bound parameters are present, so in the future a solution
1521 /// can be adopted without hitting backward compatibility issues. This is
1522 /// a [future-incompatible] lint to transition this to a hard error in the
1523 /// future. See [issue #42868] for more details, along with a description
1524 /// of the difference between early and late-bound parameters.
1525 ///
1526 /// [issue #42868]: https://github.com/rust-lang/rust/issues/42868
1527 /// [future-incompatible]: ../index.md#future-incompatible-lints
1528pub LATE_BOUND_LIFETIME_ARGUMENTS,
1529 Warn,
1530"detects generic lifetime arguments in path segments with late bound lifetime parameters",
1531 @future_incompatible = FutureIncompatibleInfo {
1532 reason: fcw!(FutureReleaseError #42868),
1533 };
1534}15351536#[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! {
1537/// The `coherence_leak_check` lint detects conflicting implementations of
1538 /// a trait that are only distinguished by the old leak-check code.
1539 ///
1540 /// ### Example
1541 ///
1542 /// ```rust
1543 /// trait SomeTrait { }
1544 /// impl SomeTrait for for<'a> fn(&'a u8) { }
1545 /// impl<'a> SomeTrait for fn(&'a u8) { }
1546 /// ```
1547 ///
1548 /// {{produces}}
1549 ///
1550 /// ### Explanation
1551 ///
1552 /// In the past, the compiler would accept trait implementations for
1553 /// identical functions that differed only in where the lifetime binder
1554 /// appeared. Due to a change in the borrow checker implementation to fix
1555 /// several bugs, this is no longer allowed. However, since this affects
1556 /// existing code, this is a [future-incompatible] lint to transition this
1557 /// to a hard error in the future.
1558 ///
1559 /// Code relying on this pattern should introduce "[newtypes]",
1560 /// like `struct Foo(for<'a> fn(&'a u8))`.
1561 ///
1562 /// See [issue #56105] for more details.
1563 ///
1564 /// [issue #56105]: https://github.com/rust-lang/rust/issues/56105
1565 /// [newtypes]: https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction
1566 /// [future-incompatible]: ../index.md#future-incompatible-lints
1567pub COHERENCE_LEAK_CHECK,
1568 Warn,
1569"distinct impls distinguished only by the leak-check code",
1570 @future_incompatible = FutureIncompatibleInfo {
1571 reason: fcw!("the behavior may change in a future release" #56105),
1572 };
1573}15741575#[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! {
1576/// The `deprecated` lint detects use of deprecated items.
1577 ///
1578 /// ### Example
1579 ///
1580 /// ```rust
1581 /// #[deprecated]
1582 /// fn foo() {}
1583 ///
1584 /// fn bar() {
1585 /// foo();
1586 /// }
1587 /// ```
1588 ///
1589 /// {{produces}}
1590 ///
1591 /// ### Explanation
1592 ///
1593 /// Items may be marked "deprecated" with the [`deprecated` attribute] to
1594 /// indicate that they should no longer be used. Usually the attribute
1595 /// should include a note on what to use instead, or check the
1596 /// documentation.
1597 ///
1598 /// [`deprecated` attribute]: https://doc.rust-lang.org/reference/attributes/diagnostics.html#the-deprecated-attribute
1599pub DEPRECATED,
1600 Warn,
1601"detects use of deprecated items",
1602 report_in_external_macro
1603}16041605#[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! {
1606/// The `unused_unsafe` lint detects unnecessary use of an `unsafe` block.
1607 ///
1608 /// ### Example
1609 ///
1610 /// ```rust
1611 /// unsafe {}
1612 /// ```
1613 ///
1614 /// {{produces}}
1615 ///
1616 /// ### Explanation
1617 ///
1618 /// If nothing within the block requires `unsafe`, then remove the
1619 /// `unsafe` marker because it is not required and may cause confusion.
1620pub UNUSED_UNSAFE,
1621 Warn,
1622"unnecessary use of an `unsafe` block"
1623}16241625#[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! {
1626/// The `unused_mut` lint detects mut variables which don't need to be
1627 /// mutable.
1628 ///
1629 /// ### Example
1630 ///
1631 /// ```rust
1632 /// let mut x = 5;
1633 /// ```
1634 ///
1635 /// {{produces}}
1636 ///
1637 /// ### Explanation
1638 ///
1639 /// The preferred style is to only mark variables as `mut` if it is
1640 /// required.
1641pub UNUSED_MUT,
1642 Warn,
1643"detect mut variables which don't need to be mutable"
1644}16451646#[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! {
1647/// The `rust_2024_incompatible_pat` lint
1648 /// detects patterns whose meaning will change in the Rust 2024 edition.
1649 ///
1650 /// ### Example
1651 ///
1652 /// ```rust,edition2021
1653 /// #![warn(rust_2024_incompatible_pat)]
1654 ///
1655 /// if let Some(&a) = &Some(&0u8) {
1656 /// let _: u8 = a;
1657 /// }
1658 /// if let Some(mut _a) = &mut Some(0u8) {
1659 /// _a = 7u8;
1660 /// }
1661 /// ```
1662 ///
1663 /// {{produces}}
1664 ///
1665 /// ### Explanation
1666 ///
1667 /// In Rust 2024 and above, the `mut` keyword does not reset the pattern binding mode,
1668 /// and nor do `&` or `&mut` patterns. The lint will suggest code that
1669 /// has the same meaning in all editions.
1670pub RUST_2024_INCOMPATIBLE_PAT,
1671 Allow,
1672"detects patterns whose meaning will change in Rust 2024",
1673 @future_incompatible = FutureIncompatibleInfo {
1674 reason: fcw!(EditionSemanticsChange 2024 "match-ergonomics"),
1675 };
1676}16771678#[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! {
1679/// The `unconditional_recursion` lint detects functions that cannot
1680 /// return without calling themselves.
1681 ///
1682 /// ### Example
1683 ///
1684 /// ```rust
1685 /// fn foo() {
1686 /// foo();
1687 /// }
1688 /// ```
1689 ///
1690 /// {{produces}}
1691 ///
1692 /// ### Explanation
1693 ///
1694 /// It is usually a mistake to have a recursive call that does not have
1695 /// some condition to cause it to terminate. If you really intend to have
1696 /// an infinite loop, using a `loop` expression is recommended.
1697pub UNCONDITIONAL_RECURSION,
1698 Warn,
1699"functions that cannot return without calling themselves"
1700}17011702#[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! {
1703/// The `single_use_lifetimes` lint detects lifetimes that are only used
1704 /// once.
1705 ///
1706 /// ### Example
1707 ///
1708 /// ```rust,compile_fail
1709 /// #![deny(single_use_lifetimes)]
1710 ///
1711 /// fn foo<'a>(x: &'a u32) {}
1712 /// ```
1713 ///
1714 /// {{produces}}
1715 ///
1716 /// ### Explanation
1717 ///
1718 /// Specifying an explicit lifetime like `'a` in a function or `impl`
1719 /// should only be used to link together two things. Otherwise, you should
1720 /// just use `'_` to indicate that the lifetime is not linked to anything,
1721 /// or elide the lifetime altogether if possible.
1722 ///
1723 /// This lint is "allow" by default because it was introduced at a time
1724 /// when `'_` and elided lifetimes were first being introduced, and this
1725 /// lint would be too noisy. Also, there are some known false positives
1726 /// that it produces. See [RFC 2115] for historical context, and [issue
1727 /// #44752] for more details.
1728 ///
1729 /// [RFC 2115]: https://github.com/rust-lang/rfcs/blob/master/text/2115-argument-lifetimes.md
1730 /// [issue #44752]: https://github.com/rust-lang/rust/issues/44752
1731pub SINGLE_USE_LIFETIMES,
1732 Allow,
1733"detects lifetime parameters that are only used once"
1734}17351736#[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! {
1737/// The `unused_lifetimes` lint detects lifetime parameters that are never
1738 /// used.
1739 ///
1740 /// ### Example
1741 ///
1742 /// ```rust,compile_fail
1743 /// #[deny(unused_lifetimes)]
1744 ///
1745 /// pub fn foo<'a>() {}
1746 /// ```
1747 ///
1748 /// {{produces}}
1749 ///
1750 /// ### Explanation
1751 ///
1752 /// Unused lifetime parameters may signal a mistake or unfinished code.
1753 /// Consider removing the parameter.
1754pub UNUSED_LIFETIMES,
1755 Allow,
1756"detects lifetime parameters that are never used"
1757}17581759#[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! {
1760/// The `redundant_lifetimes` lint detects lifetime parameters that are
1761 /// redundant because they are equal to another named lifetime.
1762 ///
1763 /// ### Example
1764 ///
1765 /// ```rust,compile_fail
1766 /// #[deny(redundant_lifetimes)]
1767 ///
1768 /// // `'a = 'static`, so all usages of `'a` can be replaced with `'static`
1769 /// pub fn bar<'a: 'static>() {}
1770 ///
1771 /// // `'a = 'b`, so all usages of `'b` can be replaced with `'a`
1772 /// pub fn bar<'a: 'b, 'b: 'a>() {}
1773 /// ```
1774 ///
1775 /// {{produces}}
1776 ///
1777 /// ### Explanation
1778 ///
1779 /// Unused lifetime parameters may signal a mistake or unfinished code.
1780 /// Consider removing the parameter.
1781pub REDUNDANT_LIFETIMES,
1782 Allow,
1783"detects lifetime parameters that are redundant because they are equal to some other named lifetime"
1784}17851786#[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! {
1787/// The `tyvar_behind_raw_pointer` lint detects raw pointer to an
1788 /// inference variable.
1789 ///
1790 /// ### Example
1791 ///
1792 /// ```rust,edition2015
1793 /// // edition 2015
1794 /// let data = std::ptr::null();
1795 /// let _ = &data as *const *const ();
1796 ///
1797 /// if data.is_null() {}
1798 /// ```
1799 ///
1800 /// {{produces}}
1801 ///
1802 /// ### Explanation
1803 ///
1804 /// This kind of inference was previously allowed, but with the future
1805 /// arrival of [arbitrary self types], this can introduce ambiguity. To
1806 /// resolve this, use an explicit type instead of relying on type
1807 /// inference.
1808 ///
1809 /// This is a [future-incompatible] lint to transition this to a hard
1810 /// error in the 2018 edition. See [issue #46906] for more details. This
1811 /// is currently a hard-error on the 2018 edition, and is "warn" by
1812 /// default in the 2015 edition.
1813 ///
1814 /// [arbitrary self types]: https://github.com/rust-lang/rust/issues/44874
1815 /// [issue #46906]: https://github.com/rust-lang/rust/issues/46906
1816 /// [future-incompatible]: ../index.md#future-incompatible-lints
1817pub TYVAR_BEHIND_RAW_POINTER,
1818 Warn,
1819"raw pointer to an inference variable",
1820 @future_incompatible = FutureIncompatibleInfo {
1821 reason: fcw!(EditionError 2018 "tyvar-behind-raw-pointer"),
1822 };
1823}18241825#[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! {
1826/// The `elided_lifetimes_in_paths` lint detects the use of hidden
1827 /// lifetime parameters.
1828 ///
1829 /// ### Example
1830 ///
1831 /// ```rust,compile_fail
1832 /// #![deny(elided_lifetimes_in_paths)]
1833 /// #![deny(warnings)]
1834 /// struct Foo<'a> {
1835 /// x: &'a u32
1836 /// }
1837 ///
1838 /// fn foo(x: &Foo) {
1839 /// }
1840 /// ```
1841 ///
1842 /// {{produces}}
1843 ///
1844 /// ### Explanation
1845 ///
1846 /// Elided lifetime parameters can make it difficult to see at a glance
1847 /// that borrowing is occurring. This lint ensures that lifetime
1848 /// parameters are always explicitly stated, even if it is the `'_`
1849 /// [placeholder lifetime].
1850 ///
1851 /// This lint is "allow" by default because it has some known issues, and
1852 /// may require a significant transition for old code.
1853 ///
1854 /// [placeholder lifetime]: https://doc.rust-lang.org/reference/lifetime-elision.html#lifetime-elision-in-functions
1855pub ELIDED_LIFETIMES_IN_PATHS,
1856 Allow,
1857"hidden lifetime parameters in types are deprecated"
1858}18591860#[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! {
1861/// The `bare_trait_objects` lint suggests using `dyn Trait` for trait
1862 /// objects.
1863 ///
1864 /// ### Example
1865 ///
1866 /// ```rust,edition2018
1867 /// trait Trait { }
1868 ///
1869 /// fn takes_trait_object(_: Box<Trait>) {
1870 /// }
1871 /// ```
1872 ///
1873 /// {{produces}}
1874 ///
1875 /// ### Explanation
1876 ///
1877 /// Without the `dyn` indicator, it can be ambiguous or confusing when
1878 /// reading code as to whether or not you are looking at a trait object.
1879 /// The `dyn` keyword makes it explicit, and adds a symmetry to contrast
1880 /// with [`impl Trait`].
1881 ///
1882 /// [`impl Trait`]: https://doc.rust-lang.org/book/ch10-02-traits.html#traits-as-parameters
1883pub BARE_TRAIT_OBJECTS,
1884 Warn,
1885"suggest using `dyn Trait` for trait objects",
1886 @future_incompatible = FutureIncompatibleInfo {
1887 reason: fcw!(EditionError 2021 "warnings-promoted-to-error"),
1888 };
1889}18901891#[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! {
1892/// The `absolute_paths_not_starting_with_crate` lint detects fully
1893 /// qualified paths that start with a module name instead of `crate`,
1894 /// `self`, or an extern crate name
1895 ///
1896 /// ### Example
1897 ///
1898 /// ```rust,edition2015,compile_fail
1899 /// #![deny(absolute_paths_not_starting_with_crate)]
1900 ///
1901 /// mod foo {
1902 /// pub fn bar() {}
1903 /// }
1904 ///
1905 /// fn main() {
1906 /// ::foo::bar();
1907 /// }
1908 /// ```
1909 ///
1910 /// {{produces}}
1911 ///
1912 /// ### Explanation
1913 ///
1914 /// Rust [editions] allow the language to evolve without breaking
1915 /// backwards compatibility. This lint catches code that uses absolute
1916 /// paths in the style of the 2015 edition. In the 2015 edition, absolute
1917 /// paths (those starting with `::`) refer to either the crate root or an
1918 /// external crate. In the 2018 edition it was changed so that they only
1919 /// refer to external crates. The path prefix `crate::` should be used
1920 /// instead to reference items from the crate root.
1921 ///
1922 /// If you switch the compiler from the 2015 to 2018 edition without
1923 /// updating the code, then it will fail to compile if the old style paths
1924 /// are used. You can manually change the paths to use the `crate::`
1925 /// prefix to transition to the 2018 edition.
1926 ///
1927 /// This lint solves the problem automatically. It is "allow" by default
1928 /// because the code is perfectly valid in the 2015 edition. The [`cargo
1929 /// fix`] tool with the `--edition` flag will switch this lint to "warn"
1930 /// and automatically apply the suggested fix from the compiler. This
1931 /// provides a completely automated way to update old code to the 2018
1932 /// edition.
1933 ///
1934 /// [editions]: https://doc.rust-lang.org/edition-guide/
1935 /// [`cargo fix`]: https://doc.rust-lang.org/cargo/commands/cargo-fix.html
1936pub ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
1937 Allow,
1938"fully qualified paths that start with a module name \
1939 instead of `crate`, `self`, or an extern crate name",
1940 @future_incompatible = FutureIncompatibleInfo {
1941 reason: fcw!(EditionError 2018 "path-changes"),
1942 };
1943}19441945#[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! {
1946/// The `unstable_name_collisions` lint detects that you have used a name
1947 /// that the standard library plans to add in the future.
1948 ///
1949 /// ### Example
1950 ///
1951 /// ```rust
1952 /// trait MyIterator : Iterator {
1953 /// // is_partitioned is an unstable method that already exists on the Iterator trait
1954 /// fn is_partitioned<P>(self, predicate: P) -> bool
1955 /// where
1956 /// Self: Sized,
1957 /// P: FnMut(Self::Item) -> bool,
1958 /// {true}
1959 /// }
1960 ///
1961 /// impl<T: ?Sized> MyIterator for T where T: Iterator { }
1962 ///
1963 /// let x = vec![1, 2, 3];
1964 /// let _ = x.iter().is_partitioned(|_| true);
1965 /// ```
1966 ///
1967 /// {{produces}}
1968 ///
1969 /// ### Explanation
1970 ///
1971 /// When new methods are added to traits in the standard library, they are
1972 /// usually added in an "unstable" form which is only available on the
1973 /// [nightly channel] with a [`feature` attribute]. If there is any
1974 /// preexisting code which extends a trait to have a method with the same
1975 /// name, then the names will collide. In the future, when the method is
1976 /// stabilized, this will cause an error due to the ambiguity. This lint
1977 /// is an early-warning to let you know that there may be a collision in
1978 /// the future. This can be avoided by adding type annotations to
1979 /// disambiguate which trait method you intend to call, such as
1980 /// `MyIterator::is_partitioned(my_iter, my_predicate)` or renaming or removing the method.
1981 ///
1982 /// [nightly channel]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
1983 /// [`feature` attribute]: https://doc.rust-lang.org/nightly/unstable-book/
1984pub UNSTABLE_NAME_COLLISIONS,
1985 Warn,
1986"detects name collision with an existing but unstable method",
1987 @future_incompatible = FutureIncompatibleInfo {
1988 reason: fcw!(
1989"once this associated item is added to the standard library, \
1990 the ambiguity may cause an error or change in behavior!"
1991#48919
1992),
1993// Note: this item represents future incompatibility of all unstable functions in the
1994 // standard library, and thus should never be removed or changed to an error.
1995};
1996}19971998#[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! {
1999/// The `irrefutable_let_patterns` lint detects [irrefutable patterns]
2000 /// in [`if let`]s, [`while let`]s, and `if let` guards.
2001 ///
2002 /// ### Example
2003 ///
2004 /// ```rust
2005 /// if let _ = 123 {
2006 /// println!("always runs!");
2007 /// }
2008 /// ```
2009 ///
2010 /// {{produces}}
2011 ///
2012 /// ### Explanation
2013 ///
2014 /// There usually isn't a reason to have an irrefutable pattern in an
2015 /// `if let` or `while let` statement, because the pattern will always match
2016 /// successfully. A [`let`] or [`loop`] statement will suffice. However,
2017 /// when generating code with a macro, forbidding irrefutable patterns
2018 /// would require awkward workarounds in situations where the macro
2019 /// doesn't know if the pattern is refutable or not. This lint allows
2020 /// macros to accept this form, while alerting for a possibly incorrect
2021 /// use in normal code.
2022 ///
2023 /// See [RFC 2086] for more details.
2024 ///
2025 /// [irrefutable patterns]: https://doc.rust-lang.org/reference/patterns.html#refutability
2026 /// [`if let`]: https://doc.rust-lang.org/reference/expressions/if-expr.html#if-let-expressions
2027 /// [`while let`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#predicate-pattern-loops
2028 /// [`let`]: https://doc.rust-lang.org/reference/statements.html#let-statements
2029 /// [`loop`]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#infinite-loops
2030 /// [RFC 2086]: https://github.com/rust-lang/rfcs/blob/master/text/2086-allow-if-let-irrefutables.md
2031pub IRREFUTABLE_LET_PATTERNS,
2032 Warn,
2033"detects irrefutable patterns in `if let` and `while let` statements"
2034}20352036#[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! {
2037/// The `unused_labels` lint detects [labels] that are never used.
2038 ///
2039 /// [labels]: https://doc.rust-lang.org/reference/expressions/loop-expr.html#loop-labels
2040 ///
2041 /// ### Example
2042 ///
2043 /// ```rust,no_run
2044 /// 'unused_label: loop {}
2045 /// ```
2046 ///
2047 /// {{produces}}
2048 ///
2049 /// ### Explanation
2050 ///
2051 /// Unused labels may signal a mistake or unfinished code. To silence the
2052 /// warning for the individual label, prefix it with an underscore such as
2053 /// `'_my_label:`.
2054pub UNUSED_LABELS,
2055 Warn,
2056"detects labels that are never used"
2057}20582059#[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! {
2060/// The `proc_macro_derive_resolution_fallback` lint detects proc macro
2061 /// derives using inaccessible names from parent modules.
2062 ///
2063 /// ### Example
2064 ///
2065 /// ```rust,ignore (proc-macro)
2066 /// // foo.rs
2067 /// #![crate_type = "proc-macro"]
2068 ///
2069 /// extern crate proc_macro;
2070 ///
2071 /// use proc_macro::*;
2072 ///
2073 /// #[proc_macro_derive(Foo)]
2074 /// pub fn foo1(a: TokenStream) -> TokenStream {
2075 /// drop(a);
2076 /// "mod __bar { static mut BAR: Option<Something> = None; }".parse().unwrap()
2077 /// }
2078 /// ```
2079 ///
2080 /// ```rust,ignore (needs-dependency)
2081 /// // bar.rs
2082 /// #[macro_use]
2083 /// extern crate foo;
2084 ///
2085 /// struct Something;
2086 ///
2087 /// #[derive(Foo)]
2088 /// struct Another;
2089 ///
2090 /// fn main() {}
2091 /// ```
2092 ///
2093 /// This will produce:
2094 ///
2095 /// ```text
2096 /// warning: cannot find type `Something` in this scope
2097 /// --> src/main.rs:8:10
2098 /// |
2099 /// 8 | #[derive(Foo)]
2100 /// | ^^^ names from parent modules are not accessible without an explicit import
2101 /// |
2102 /// = note: `#[warn(proc_macro_derive_resolution_fallback)]` on by default
2103 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
2104 /// = note: for more information, see issue #50504 <https://github.com/rust-lang/rust/issues/50504>
2105 /// ```
2106 ///
2107 /// ### Explanation
2108 ///
2109 /// If a proc-macro generates a module, the compiler unintentionally
2110 /// allowed items in that module to refer to items in the crate root
2111 /// without importing them. This is a [future-incompatible] lint to
2112 /// transition this to a hard error in the future. See [issue #50504] for
2113 /// more details.
2114 ///
2115 /// [issue #50504]: https://github.com/rust-lang/rust/issues/50504
2116 /// [future-incompatible]: ../index.md#future-incompatible-lints
2117pub PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
2118 Deny,
2119"detects proc macro derives using inaccessible names from parent modules",
2120 @future_incompatible = FutureIncompatibleInfo {
2121 reason: fcw!(FutureReleaseError #83583),
2122 report_in_deps: true,
2123 };
2124}21252126#[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! {
2127/// The `macro_use_extern_crate` lint detects the use of the [`macro_use` attribute].
2128 ///
2129 /// ### Example
2130 ///
2131 /// ```rust,ignore (needs extern crate)
2132 /// #![deny(macro_use_extern_crate)]
2133 ///
2134 /// #[macro_use]
2135 /// extern crate serde_json;
2136 ///
2137 /// fn main() {
2138 /// let _ = json!{{}};
2139 /// }
2140 /// ```
2141 ///
2142 /// This will produce:
2143 ///
2144 /// ```text
2145 /// error: applying the `#[macro_use]` attribute to an `extern crate` item is deprecated
2146 /// --> src/main.rs:3:1
2147 /// |
2148 /// 3 | #[macro_use]
2149 /// | ^^^^^^^^^^^^
2150 /// |
2151 /// = help: remove it and import macros at use sites with a `use` item instead
2152 /// note: the lint level is defined here
2153 /// --> src/main.rs:1:9
2154 /// |
2155 /// 1 | #![deny(macro_use_extern_crate)]
2156 /// | ^^^^^^^^^^^^^^^^^^^^^^
2157 /// ```
2158 ///
2159 /// ### Explanation
2160 ///
2161 /// The [`macro_use` attribute] on an [`extern crate`] item causes
2162 /// macros in that external crate to be brought into the prelude of the
2163 /// crate, making the macros in scope everywhere. As part of the efforts
2164 /// to simplify handling of dependencies in the [2018 edition], the use of
2165 /// `extern crate` is being phased out. To bring macros from extern crates
2166 /// into scope, it is recommended to use a [`use` import].
2167 ///
2168 /// This lint is "allow" by default because this is a stylistic choice
2169 /// that has not been settled, see [issue #52043] for more information.
2170 ///
2171 /// [`macro_use` attribute]: https://doc.rust-lang.org/reference/macros-by-example.html#the-macro_use-attribute
2172 /// [`use` import]: https://doc.rust-lang.org/reference/items/use-declarations.html
2173 /// [issue #52043]: https://github.com/rust-lang/rust/issues/52043
2174pub MACRO_USE_EXTERN_CRATE,
2175 Allow,
2176"the `#[macro_use]` attribute is now deprecated in favor of using macros \
2177 via the module system"
2178}21792180#[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! {
2181/// The `macro_expanded_macro_exports_accessed_by_absolute_paths` lint
2182 /// detects macro-expanded [`macro_export`] macros from the current crate
2183 /// that cannot be referred to by absolute paths.
2184 ///
2185 /// [`macro_export`]: https://doc.rust-lang.org/reference/macros-by-example.html#path-based-scope
2186 ///
2187 /// ### Example
2188 ///
2189 /// ```rust,compile_fail
2190 /// macro_rules! define_exported {
2191 /// () => {
2192 /// #[macro_export]
2193 /// macro_rules! exported {
2194 /// () => {};
2195 /// }
2196 /// };
2197 /// }
2198 ///
2199 /// define_exported!();
2200 ///
2201 /// fn main() {
2202 /// crate::exported!();
2203 /// }
2204 /// ```
2205 ///
2206 /// {{produces}}
2207 ///
2208 /// ### Explanation
2209 ///
2210 /// The intent is that all macros marked with the `#[macro_export]`
2211 /// attribute are made available in the root of the crate. However, when a
2212 /// `macro_rules!` definition is generated by another macro, the macro
2213 /// expansion is unable to uphold this rule. This is a
2214 /// [future-incompatible] lint to transition this to a hard error in the
2215 /// future. See [issue #53495] for more details.
2216 ///
2217 /// [issue #53495]: https://github.com/rust-lang/rust/issues/53495
2218 /// [future-incompatible]: ../index.md#future-incompatible-lints
2219pub MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2220 Deny,
2221"macro-expanded `macro_export` macros from the current crate \
2222 cannot be referred to by absolute paths",
2223 @future_incompatible = FutureIncompatibleInfo {
2224 reason: fcw!(FutureReleaseError #52234),
2225 report_in_deps: true,
2226 };
2227 crate_level_only
2228}22292230#[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! {
2231/// The `explicit_outlives_requirements` lint detects unnecessary
2232 /// lifetime bounds that can be inferred.
2233 ///
2234 /// ### Example
2235 ///
2236 /// ```rust,compile_fail
2237 /// # #![allow(unused)]
2238 /// #![deny(explicit_outlives_requirements)]
2239 /// #![deny(warnings)]
2240 ///
2241 /// struct SharedRef<'a, T>
2242 /// where
2243 /// T: 'a,
2244 /// {
2245 /// data: &'a T,
2246 /// }
2247 /// ```
2248 ///
2249 /// {{produces}}
2250 ///
2251 /// ### Explanation
2252 ///
2253 /// If a `struct` contains a reference, such as `&'a T`, the compiler
2254 /// requires that `T` outlives the lifetime `'a`. This historically
2255 /// required writing an explicit lifetime bound to indicate this
2256 /// requirement. However, this can be overly explicit, causing clutter and
2257 /// unnecessary complexity. The language was changed to automatically
2258 /// infer the bound if it is not specified. Specifically, if the struct
2259 /// contains a reference, directly or indirectly, to `T` with lifetime
2260 /// `'x`, then it will infer that `T: 'x` is a requirement.
2261 ///
2262 /// This lint is "allow" by default because it can be noisy for existing
2263 /// code that already had these requirements. This is a stylistic choice,
2264 /// as it is still valid to explicitly state the bound. It also has some
2265 /// false positives that can cause confusion.
2266 ///
2267 /// See [RFC 2093] for more details.
2268 ///
2269 /// [RFC 2093]: https://github.com/rust-lang/rfcs/blob/master/text/2093-infer-outlives.md
2270pub EXPLICIT_OUTLIVES_REQUIREMENTS,
2271 Allow,
2272"outlives requirements can be inferred"
2273}22742275#[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! {
2276/// The `deprecated_in_future` lint is internal to rustc and should not be
2277 /// used by user code.
2278 ///
2279 /// This lint is only enabled in the standard library. It works with the
2280 /// use of `#[deprecated]` with a `since` field of a version in the future.
2281 /// This allows something to be marked as deprecated in a future version,
2282 /// and then this lint will ensure that the item is no longer used in the
2283 /// standard library. See the [stability documentation] for more details.
2284 ///
2285 /// [stability documentation]: https://rustc-dev-guide.rust-lang.org/stability.html#deprecated
2286pub DEPRECATED_IN_FUTURE,
2287 Allow,
2288"detects use of items that will be deprecated in a future version",
2289 report_in_external_macro
2290}22912292#[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! {
2293/// The `ambiguous_associated_items` lint detects ambiguity between
2294 /// [associated items] and [enum variants].
2295 ///
2296 /// [associated items]: https://doc.rust-lang.org/reference/items/associated-items.html
2297 /// [enum variants]: https://doc.rust-lang.org/reference/items/enumerations.html
2298 ///
2299 /// ### Example
2300 ///
2301 /// ```rust,compile_fail
2302 /// enum E {
2303 /// V
2304 /// }
2305 ///
2306 /// trait Tr {
2307 /// type V;
2308 /// fn foo() -> Self::V;
2309 /// }
2310 ///
2311 /// impl Tr for E {
2312 /// type V = u8;
2313 /// // `Self::V` is ambiguous because it may refer to the associated type or
2314 /// // the enum variant.
2315 /// fn foo() -> Self::V { 0 }
2316 /// }
2317 /// ```
2318 ///
2319 /// {{produces}}
2320 ///
2321 /// ### Explanation
2322 ///
2323 /// Previous versions of Rust did not allow accessing enum variants
2324 /// through [type aliases]. When this ability was added (see [RFC 2338]), this
2325 /// introduced some situations where it can be ambiguous what a type
2326 /// was referring to.
2327 ///
2328 /// To fix this ambiguity, you should use a [qualified path] to explicitly
2329 /// state which type to use. For example, in the above example the
2330 /// function can be written as `fn f() -> <Self as Tr>::V { 0 }` to
2331 /// specifically refer to the associated type.
2332 ///
2333 /// This is a [future-incompatible] lint to transition this to a hard
2334 /// error in the future. See [issue #57644] for more details.
2335 ///
2336 /// [issue #57644]: https://github.com/rust-lang/rust/issues/57644
2337 /// [type aliases]: https://doc.rust-lang.org/reference/items/type-aliases.html#type-aliases
2338 /// [RFC 2338]: https://github.com/rust-lang/rfcs/blob/master/text/2338-type-alias-enum-variants.md
2339 /// [qualified path]: https://doc.rust-lang.org/reference/paths.html#qualified-paths
2340 /// [future-incompatible]: ../index.md#future-incompatible-lints
2341pub AMBIGUOUS_ASSOCIATED_ITEMS,
2342 Deny,
2343"ambiguous associated items",
2344 @future_incompatible = FutureIncompatibleInfo {
2345 reason: fcw!(FutureReleaseError #57644),
2346 };
2347}23482349#[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! {
2350/// The `inline_no_sanitize` lint detects incompatible use of
2351 /// [`#[inline(always)]`][inline] and [`#[sanitize(xyz = "off")]`][sanitize].
2352 ///
2353 /// [inline]: https://doc.rust-lang.org/reference/attributes/codegen.html#the-inline-attribute
2354 /// [sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html
2355 ///
2356 /// ### Example
2357 ///
2358 /// ```rust
2359 /// #![feature(sanitize)]
2360 ///
2361 /// #[inline(always)]
2362 /// #[sanitize(address = "off")]
2363 /// fn x() {}
2364 ///
2365 /// fn main() {
2366 /// x()
2367 /// }
2368 /// ```
2369 ///
2370 /// {{produces}}
2371 ///
2372 /// ### Explanation
2373 ///
2374 /// The use of the [`#[inline(always)]`][inline] attribute prevents the
2375 /// the [`#[sanitize(xyz = "off")]`][sanitize] attribute from working.
2376 /// Consider temporarily removing `inline` attribute.
2377pub INLINE_NO_SANITIZE,
2378 Warn,
2379r#"detects incompatible use of `#[inline(always)]` and `#[sanitize(... = "off")]`"#,
2380}23812382#[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! {
2383/// The `rtsan_nonblocking_async` lint detects incompatible use of
2384 /// [`#[sanitize(realtime = "nonblocking")]`][sanitize] on async functions.
2385 ///
2386 /// [sanitize]: https://doc.rust-lang.org/nightly/unstable-book/language-features/no-sanitize.html
2387 /// ### Example
2388 ///
2389 /// ```rust,no_run
2390 /// #![feature(sanitize)]
2391 ///
2392 /// #[sanitize(realtime = "nonblocking")]
2393 /// async fn x() {}
2394 ///
2395 /// fn main() {
2396 /// x();
2397 /// }
2398 /// ```
2399 ///
2400 /// {{produces}}
2401 ///
2402 /// ### Explanation
2403 ///
2404 /// The sanitizer only considers the async function body nonblocking. The executor, which runs on
2405 /// every `.await` point can run non-realtime code, without the sanitizer catching it.
2406pub RTSAN_NONBLOCKING_ASYNC,
2407 Warn,
2408r#"detects incompatible uses of `#[sanitize(realtime = "nonblocking")]` on async functions"#,
2409}24102411#[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! {
2412/// The `asm_sub_register` lint detects using only a subset of a register
2413 /// for inline asm inputs.
2414 ///
2415 /// ### Example
2416 ///
2417 /// ```rust,ignore (fails on non-x86_64)
2418 /// #[cfg(target_arch="x86_64")]
2419 /// use std::arch::asm;
2420 ///
2421 /// fn main() {
2422 /// #[cfg(target_arch="x86_64")]
2423 /// unsafe {
2424 /// asm!("mov {0}, {0}", in(reg) 0i16);
2425 /// }
2426 /// }
2427 /// ```
2428 ///
2429 /// This will produce:
2430 ///
2431 /// ```text
2432 /// warning: formatting may not be suitable for sub-register argument
2433 /// --> src/main.rs:7:19
2434 /// |
2435 /// 7 | asm!("mov {0}, {0}", in(reg) 0i16);
2436 /// | ^^^ ^^^ ---- for this argument
2437 /// |
2438 /// = note: `#[warn(asm_sub_register)]` on by default
2439 /// = help: use the `x` modifier to have the register formatted as `ax`
2440 /// = help: or use the `r` modifier to keep the default formatting of `rax`
2441 /// ```
2442 ///
2443 /// ### Explanation
2444 ///
2445 /// Registers on some architectures can use different names to refer to a
2446 /// subset of the register. By default, the compiler will use the name for
2447 /// the full register size. To explicitly use a subset of the register,
2448 /// you can override the default by using a modifier on the template
2449 /// string operand to specify when subregister to use. This lint is issued
2450 /// if you pass in a value with a smaller data type than the default
2451 /// register size, to alert you of possibly using the incorrect width. To
2452 /// fix this, add the suggested modifier to the template, or cast the
2453 /// value to the correct size.
2454 ///
2455 /// See [register template modifiers] in the reference for more details.
2456 ///
2457 /// [register template modifiers]: https://doc.rust-lang.org/nightly/reference/inline-assembly.html#template-modifiers
2458pub ASM_SUB_REGISTER,
2459 Warn,
2460"using only a subset of a register for inline asm inputs",
2461}24622463#[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! {
2464/// The `bad_asm_style` lint detects the use of the `.intel_syntax` and
2465 /// `.att_syntax` directives.
2466 ///
2467 /// ### Example
2468 ///
2469 /// ```rust,ignore (fails on non-x86_64)
2470 /// #[cfg(target_arch="x86_64")]
2471 /// use std::arch::asm;
2472 ///
2473 /// fn main() {
2474 /// #[cfg(target_arch="x86_64")]
2475 /// unsafe {
2476 /// asm!(
2477 /// ".att_syntax",
2478 /// "movq %{0}, %{0}", in(reg) 0usize
2479 /// );
2480 /// }
2481 /// }
2482 /// ```
2483 ///
2484 /// This will produce:
2485 ///
2486 /// ```text
2487 /// warning: avoid using `.att_syntax`, prefer using `options(att_syntax)` instead
2488 /// --> src/main.rs:8:14
2489 /// |
2490 /// 8 | ".att_syntax",
2491 /// | ^^^^^^^^^^^
2492 /// |
2493 /// = note: `#[warn(bad_asm_style)]` on by default
2494 /// ```
2495 ///
2496 /// ### Explanation
2497 ///
2498 /// On x86, `asm!` uses the intel assembly syntax by default. While this
2499 /// can be switched using assembler directives like `.att_syntax`, using the
2500 /// `att_syntax` option is recommended instead because it will also properly
2501 /// prefix register placeholders with `%` as required by AT&T syntax.
2502pub BAD_ASM_STYLE,
2503 Warn,
2504"incorrect use of inline assembly",
2505}25062507#[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! {
2508/// The `unsafe_op_in_unsafe_fn` lint detects unsafe operations in unsafe
2509 /// functions without an explicit unsafe block.
2510 ///
2511 /// ### Example
2512 ///
2513 /// ```rust,compile_fail
2514 /// #![deny(unsafe_op_in_unsafe_fn)]
2515 ///
2516 /// unsafe fn foo() {}
2517 ///
2518 /// unsafe fn bar() {
2519 /// foo();
2520 /// }
2521 ///
2522 /// fn main() {}
2523 /// ```
2524 ///
2525 /// {{produces}}
2526 ///
2527 /// ### Explanation
2528 ///
2529 /// Currently, an [`unsafe fn`] allows any [unsafe] operation within its
2530 /// body. However, this can increase the surface area of code that needs
2531 /// to be scrutinized for proper behavior. The [`unsafe` block] provides a
2532 /// convenient way to make it clear exactly which parts of the code are
2533 /// performing unsafe operations. In the future, it is desired to change
2534 /// it so that unsafe operations cannot be performed in an `unsafe fn`
2535 /// without an `unsafe` block.
2536 ///
2537 /// The fix to this is to wrap the unsafe code in an `unsafe` block.
2538 ///
2539 /// This lint is "allow" by default on editions up to 2021, from 2024 it is
2540 /// "warn" by default; the plan for increasing severity further is
2541 /// still being considered. See [RFC #2585] and [issue #71668] for more
2542 /// details.
2543 ///
2544 /// [`unsafe fn`]: https://doc.rust-lang.org/reference/unsafe-functions.html
2545 /// [`unsafe` block]: https://doc.rust-lang.org/reference/expressions/block-expr.html#unsafe-blocks
2546 /// [unsafe]: https://doc.rust-lang.org/reference/unsafety.html
2547 /// [RFC #2585]: https://github.com/rust-lang/rfcs/blob/master/text/2585-unsafe-block-in-unsafe-fn.md
2548 /// [issue #71668]: https://github.com/rust-lang/rust/issues/71668
2549pub UNSAFE_OP_IN_UNSAFE_FN,
2550 Allow,
2551"unsafe operations in unsafe functions without an explicit unsafe block are deprecated",
2552 @future_incompatible = FutureIncompatibleInfo {
2553 reason: fcw!(EditionError 2024 "unsafe-op-in-unsafe-fn"),
2554 explain_reason: false
2555};
2556 @edition Edition2024 => Warn;
2557}25582559#[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! {
2560/// The `fuzzy_provenance_casts` lint detects an `as` cast between an integer
2561 /// and a pointer.
2562 ///
2563 /// ### Example
2564 ///
2565 /// ```rust
2566 /// #![feature(strict_provenance_lints)]
2567 /// #![warn(fuzzy_provenance_casts)]
2568 ///
2569 /// fn main() {
2570 /// let _dangling = 16_usize as *const u8;
2571 /// }
2572 /// ```
2573 ///
2574 /// {{produces}}
2575 ///
2576 /// ### Explanation
2577 ///
2578 /// This lint is part of the strict provenance effort, see [issue #95228].
2579 /// Casting an integer to a pointer is considered bad style, as a pointer
2580 /// contains, besides the *address* also a *provenance*, indicating what
2581 /// memory the pointer is allowed to read/write. Casting an integer, which
2582 /// doesn't have provenance, to a pointer requires the compiler to assign
2583 /// (guess) provenance. The compiler assigns "all exposed valid" (see the
2584 /// docs of [`ptr::with_exposed_provenance`] for more information about this
2585 /// "exposing"). This penalizes the optimiser and is not well suited for
2586 /// dynamic analysis/dynamic program verification (e.g. Miri or CHERI
2587 /// platforms).
2588 ///
2589 /// It is much better to use [`ptr::with_addr`] instead to specify the
2590 /// provenance you want. If using this function is not possible because the
2591 /// code relies on exposed provenance then there is as an escape hatch
2592 /// [`ptr::with_exposed_provenance`].
2593 ///
2594 /// [issue #95228]: https://github.com/rust-lang/rust/issues/95228
2595 /// [`ptr::with_addr`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.with_addr
2596 /// [`ptr::with_exposed_provenance`]: https://doc.rust-lang.org/core/ptr/fn.with_exposed_provenance.html
2597pub FUZZY_PROVENANCE_CASTS,
2598 Allow,
2599"a fuzzy integer to pointer cast is used",
2600 @feature_gate = strict_provenance_lints;
2601}26022603#[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! {
2604/// The `lossy_provenance_casts` lint detects an `as` cast between a pointer
2605 /// and an integer.
2606 ///
2607 /// ### Example
2608 ///
2609 /// ```rust
2610 /// #![feature(strict_provenance_lints)]
2611 /// #![warn(lossy_provenance_casts)]
2612 ///
2613 /// fn main() {
2614 /// let x: u8 = 37;
2615 /// let _addr: usize = &x as *const u8 as usize;
2616 /// }
2617 /// ```
2618 ///
2619 /// {{produces}}
2620 ///
2621 /// ### Explanation
2622 ///
2623 /// This lint is part of the strict provenance effort, see [issue #95228].
2624 /// Casting a pointer to an integer is a lossy operation, because beyond
2625 /// just an *address* a pointer may be associated with a particular
2626 /// *provenance*. This information is used by the optimiser and for dynamic
2627 /// analysis/dynamic program verification (e.g. Miri or CHERI platforms).
2628 ///
2629 /// Since this cast is lossy, it is considered good style to use the
2630 /// [`ptr::addr`] method instead, which has a similar effect, but doesn't
2631 /// "expose" the pointer provenance. This improves optimisation potential.
2632 /// See the docs of [`ptr::addr`] and [`ptr::expose_provenance`] for more information
2633 /// about exposing pointer provenance.
2634 ///
2635 /// If your code can't comply with strict provenance and needs to expose
2636 /// the provenance, then there is [`ptr::expose_provenance`] as an escape hatch,
2637 /// which preserves the behaviour of `as usize` casts while being explicit
2638 /// about the semantics.
2639 ///
2640 /// [issue #95228]: https://github.com/rust-lang/rust/issues/95228
2641 /// [`ptr::addr`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.addr
2642 /// [`ptr::expose_provenance`]: https://doc.rust-lang.org/core/primitive.pointer.html#method.expose_provenance
2643pub LOSSY_PROVENANCE_CASTS,
2644 Allow,
2645"a lossy pointer to integer cast is used",
2646 @feature_gate = strict_provenance_lints;
2647}26482649#[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! {
2650/// The `const_evaluatable_unchecked` lint detects a generic constant used
2651 /// in a type.
2652 ///
2653 /// ### Example
2654 ///
2655 /// ```rust
2656 /// const fn foo<T>() -> usize {
2657 /// if size_of::<*mut T>() < 8 { // size of *mut T does not depend on T
2658 /// 4
2659 /// } else {
2660 /// 8
2661 /// }
2662 /// }
2663 ///
2664 /// fn test<T>() {
2665 /// let _ = [0; foo::<T>()];
2666 /// }
2667 /// ```
2668 ///
2669 /// {{produces}}
2670 ///
2671 /// ### Explanation
2672 ///
2673 /// In the 1.43 release, some uses of generic parameters in array repeat
2674 /// expressions were accidentally allowed. This is a [future-incompatible]
2675 /// lint to transition this to a hard error in the future. See [issue
2676 /// #76200] for a more detailed description and possible fixes.
2677 ///
2678 /// [future-incompatible]: ../index.md#future-incompatible-lints
2679 /// [issue #76200]: https://github.com/rust-lang/rust/issues/76200
2680pub CONST_EVALUATABLE_UNCHECKED,
2681 Warn,
2682"detects a generic constant is used in a type without a emitting a warning",
2683 @future_incompatible = FutureIncompatibleInfo {
2684 reason: fcw!(FutureReleaseError #76200),
2685 };
2686}26872688#[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! {
2689/// The `function_item_references` lint detects function references that are
2690 /// formatted with [`fmt::Pointer`] or transmuted.
2691 ///
2692 /// [`fmt::Pointer`]: https://doc.rust-lang.org/std/fmt/trait.Pointer.html
2693 ///
2694 /// ### Example
2695 ///
2696 /// ```rust
2697 /// fn foo() { }
2698 ///
2699 /// fn main() {
2700 /// println!("{:p}", &foo);
2701 /// }
2702 /// ```
2703 ///
2704 /// {{produces}}
2705 ///
2706 /// ### Explanation
2707 ///
2708 /// Taking a reference to a function may be mistaken as a way to obtain a
2709 /// pointer to that function. This can give unexpected results when
2710 /// formatting the reference as a pointer or transmuting it. This lint is
2711 /// issued when function references are formatted as pointers, passed as
2712 /// arguments bound by [`fmt::Pointer`] or transmuted.
2713pub FUNCTION_ITEM_REFERENCES,
2714 Warn,
2715"suggest casting to a function pointer when attempting to take references to function items",
2716}27172718#[doc = r" The `uninhabited_static` lint detects uninhabited statics."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,compile_fail"]
#[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::Deny,
desc: "uninhabited static",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 74840,
}),
report_in_deps: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
2719/// The `uninhabited_static` lint detects uninhabited statics.
2720 ///
2721 /// ### Example
2722 ///
2723 /// ```rust,compile_fail
2724 /// enum Void {}
2725 /// unsafe extern {
2726 /// static EXTERN: Void;
2727 /// }
2728 /// ```
2729 ///
2730 /// {{produces}}
2731 ///
2732 /// ### Explanation
2733 ///
2734 /// Statics with an uninhabited type can never be initialized, so they are impossible to define.
2735 /// However, this can be side-stepped with an `extern static`, leading to problems later in the
2736 /// compiler which assumes that there are no initialized uninhabited places (such as locals or
2737 /// statics). This was accidentally allowed, but is being phased out.
2738pub UNINHABITED_STATIC,
2739 Deny,
2740"uninhabited static",
2741 @future_incompatible = FutureIncompatibleInfo {
2742 reason: fcw!(FutureReleaseError #74840),
2743 report_in_deps: true,
2744 };
2745}27462747#[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! {
2748/// The `unnameable_test_items` lint detects [`#[test]`][test] functions
2749 /// that are not able to be run by the test harness because they are in a
2750 /// position where they are not nameable.
2751 ///
2752 /// [test]: https://doc.rust-lang.org/reference/attributes/testing.html#the-test-attribute
2753 ///
2754 /// ### Example
2755 ///
2756 /// ```rust,test
2757 /// fn main() {
2758 /// #[test]
2759 /// fn foo() {
2760 /// // This test will not fail because it does not run.
2761 /// assert_eq!(1, 2);
2762 /// }
2763 /// }
2764 /// ```
2765 ///
2766 /// {{produces}}
2767 ///
2768 /// ### Explanation
2769 ///
2770 /// In order for the test harness to run a test, the test function must be
2771 /// located in a position where it can be accessed from the crate root.
2772 /// This generally means it must be defined in a module, and not anywhere
2773 /// else such as inside another function. The compiler previously allowed
2774 /// this without an error, so a lint was added as an alert that a test is
2775 /// not being used. Whether or not this should be allowed has not yet been
2776 /// decided, see [RFC 2471] and [issue #36629].
2777 ///
2778 /// [RFC 2471]: https://github.com/rust-lang/rfcs/pull/2471#issuecomment-397414443
2779 /// [issue #36629]: https://github.com/rust-lang/rust/issues/36629
2780pub UNNAMEABLE_TEST_ITEMS,
2781 Warn,
2782"detects an item that cannot be named being marked as `#[test_case]`",
2783 report_in_external_macro
2784}27852786#[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! {
2787/// The `useless_deprecated` lint detects deprecation attributes with no effect.
2788 ///
2789 /// ### Example
2790 ///
2791 /// ```rust,compile_fail
2792 /// struct X;
2793 ///
2794 /// #[deprecated = "message"]
2795 /// impl Default for X {
2796 /// fn default() -> Self {
2797 /// X
2798 /// }
2799 /// }
2800 /// ```
2801 ///
2802 /// {{produces}}
2803 ///
2804 /// ### Explanation
2805 ///
2806 /// Deprecation attributes have no effect on trait implementations.
2807pub USELESS_DEPRECATED,
2808 Deny,
2809"detects deprecation attributes with no effect",
2810}28112812#[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! {
2813/// The `ineffective_unstable_trait_impl` lint detects `#[unstable]` attributes which are not used.
2814 ///
2815 /// ### Example
2816 ///
2817 /// ```rust,compile_fail
2818 /// #![feature(staged_api)]
2819 ///
2820 /// #[derive(Clone)]
2821 /// #[stable(feature = "x", since = "1")]
2822 /// struct S {}
2823 ///
2824 /// #[unstable(feature = "y", issue = "none")]
2825 /// impl Copy for S {}
2826 /// ```
2827 ///
2828 /// {{produces}}
2829 ///
2830 /// ### Explanation
2831 ///
2832 /// `staged_api` does not currently support using a stability attribute on `impl` blocks.
2833 /// `impl`s are always stable if both the type and trait are stable, and always unstable otherwise.
2834pub INEFFECTIVE_UNSTABLE_TRAIT_IMPL,
2835 Deny,
2836"detects `#[unstable]` on stable trait implementations for stable types"
2837}28382839#[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! {
2840/// The `self_constructor_from_outer_item` lint detects cases where the `Self` constructor
2841 /// was silently allowed due to a bug in the resolver, and which may produce surprising
2842 /// and unintended behavior.
2843 ///
2844 /// Using a `Self` type alias from an outer item was never intended, but was silently allowed.
2845 /// This is deprecated -- and is a hard error when the `Self` type alias references generics
2846 /// that are not in scope.
2847 ///
2848 /// ### Example
2849 ///
2850 /// ```rust,compile_fail
2851 /// #![deny(self_constructor_from_outer_item)]
2852 ///
2853 /// struct S0(usize);
2854 ///
2855 /// impl S0 {
2856 /// fn foo() {
2857 /// const C: S0 = Self(0);
2858 /// fn bar() -> S0 {
2859 /// Self(0)
2860 /// }
2861 /// }
2862 /// }
2863 /// ```
2864 ///
2865 /// {{produces}}
2866 ///
2867 /// ### Explanation
2868 ///
2869 /// The `Self` type alias should not be reachable because nested items are not associated with
2870 /// the scope of the parameters from the parent item.
2871pub SELF_CONSTRUCTOR_FROM_OUTER_ITEM,
2872 Warn,
2873"detect unsupported use of `Self` from outer item",
2874 @future_incompatible = FutureIncompatibleInfo {
2875 reason: fcw!(FutureReleaseError #124186),
2876 };
2877}28782879#[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! {
2880/// The `semicolon_in_expressions_from_macros` lint detects trailing semicolons
2881 /// in macro bodies when the macro is invoked in expression position.
2882 /// This was previous accepted, but is being phased out.
2883 ///
2884 /// ### Example
2885 ///
2886 /// ```rust,compile_fail
2887 /// #![deny(semicolon_in_expressions_from_macros)]
2888 /// macro_rules! foo {
2889 /// () => { true; }
2890 /// }
2891 ///
2892 /// fn main() {
2893 /// let val = match true {
2894 /// true => false,
2895 /// _ => foo!()
2896 /// };
2897 /// }
2898 /// ```
2899 ///
2900 /// {{produces}}
2901 ///
2902 /// ### Explanation
2903 ///
2904 /// Previous, Rust ignored trailing semicolon in a macro
2905 /// body when a macro was invoked in expression position.
2906 /// However, this makes the treatment of semicolons in the language
2907 /// inconsistent, and could lead to unexpected runtime behavior
2908 /// in some circumstances (e.g. if the macro author expects
2909 /// a value to be dropped).
2910 ///
2911 /// This is a [future-incompatible] lint to transition this
2912 /// to a hard error in the future. See [issue #79813] for more details.
2913 ///
2914 /// [issue #79813]: https://github.com/rust-lang/rust/issues/79813
2915 /// [future-incompatible]: ../index.md#future-incompatible-lints
2916pub SEMICOLON_IN_EXPRESSIONS_FROM_MACROS,
2917 Deny,
2918"trailing semicolon in macro body used as expression",
2919 @future_incompatible = FutureIncompatibleInfo {
2920 reason: fcw!(FutureReleaseError #79813),
2921 report_in_deps: true,
2922 };
2923}29242925#[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! {
2926/// The `legacy_derive_helpers` lint detects derive helper attributes
2927 /// that are used before they are introduced.
2928 ///
2929 /// ### Example
2930 ///
2931 /// ```rust,ignore (needs extern crate)
2932 /// #[serde(rename_all = "camelCase")]
2933 /// #[derive(Deserialize)]
2934 /// struct S { /* fields */ }
2935 /// ```
2936 ///
2937 /// produces:
2938 ///
2939 /// ```text
2940 /// warning: derive helper attribute is used before it is introduced
2941 /// --> $DIR/legacy-derive-helpers.rs:1:3
2942 /// |
2943 /// 1 | #[serde(rename_all = "camelCase")]
2944 /// | ^^^^^
2945 /// ...
2946 /// 2 | #[derive(Deserialize)]
2947 /// | ----------- the attribute is introduced here
2948 /// ```
2949 ///
2950 /// ### Explanation
2951 ///
2952 /// Attributes like this work for historical reasons, but attribute expansion works in
2953 /// left-to-right order in general, so, to resolve `#[serde]`, compiler has to try to "look
2954 /// into the future" at not yet expanded part of the item , but such attempts are not always
2955 /// reliable.
2956 ///
2957 /// To fix the warning place the helper attribute after its corresponding derive.
2958 /// ```rust,ignore (needs extern crate)
2959 /// #[derive(Deserialize)]
2960 /// #[serde(rename_all = "camelCase")]
2961 /// struct S { /* fields */ }
2962 /// ```
2963pub LEGACY_DERIVE_HELPERS,
2964 Deny,
2965"detects derive helper attributes that are used before they are introduced",
2966 @future_incompatible = FutureIncompatibleInfo {
2967 reason: fcw!(FutureReleaseError #79202),
2968 report_in_deps: true,
2969 };
2970}29712972#[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! {
2973/// The `large_assignments` lint detects when objects of large
2974 /// types are being moved around.
2975 ///
2976 /// ### Example
2977 ///
2978 /// ```rust,ignore (can crash on some platforms)
2979 /// let x = [0; 50000];
2980 /// let y = x;
2981 /// ```
2982 ///
2983 /// produces:
2984 ///
2985 /// ```text
2986 /// warning: moving a large value
2987 /// --> $DIR/move-large.rs:1:3
2988 /// let y = x;
2989 /// - Copied large value here
2990 /// ```
2991 ///
2992 /// ### Explanation
2993 ///
2994 /// When using a large type in a plain assignment or in a function
2995 /// argument, idiomatic code can be inefficient.
2996 /// Ideally appropriate optimizations would resolve this, but such
2997 /// optimizations are only done in a best-effort manner.
2998 /// This lint will trigger on all sites of large moves and thus allow the
2999 /// user to resolve them in code.
3000pub LARGE_ASSIGNMENTS,
3001 Warn,
3002"detects large moves or copies",
3003}30043005#[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! {
3006/// The `unexpected_cfgs` lint detects unexpected conditional compilation conditions.
3007 ///
3008 /// ### Example
3009 ///
3010 /// ```text
3011 /// rustc --check-cfg 'cfg()'
3012 /// ```
3013 ///
3014 /// ```rust,ignore (needs command line option)
3015 /// #[cfg(widnows)]
3016 /// fn foo() {}
3017 /// ```
3018 ///
3019 /// This will produce:
3020 ///
3021 /// ```text
3022 /// warning: unexpected `cfg` condition name: `widnows`
3023 /// --> lint_example.rs:1:7
3024 /// |
3025 /// 1 | #[cfg(widnows)]
3026 /// | ^^^^^^^
3027 /// |
3028 /// = note: `#[warn(unexpected_cfgs)]` on by default
3029 /// ```
3030 ///
3031 /// ### Explanation
3032 ///
3033 /// This lint is only active when [`--check-cfg`][check-cfg] arguments are being
3034 /// passed to the compiler and triggers whenever an unexpected condition name or value is
3035 /// used.
3036 ///
3037 /// See the [Checking Conditional Configurations][check-cfg] section for more
3038 /// details.
3039 ///
3040 /// See the [Cargo Specifics][unexpected_cfgs_lint_config] section for configuring this lint in
3041 /// `Cargo.toml`.
3042 ///
3043 /// [check-cfg]: https://doc.rust-lang.org/nightly/rustc/check-cfg.html
3044 /// [unexpected_cfgs_lint_config]: https://doc.rust-lang.org/nightly/rustc/check-cfg/cargo-specifics.html#check-cfg-in-lintsrust-table
3045pub UNEXPECTED_CFGS,
3046 Warn,
3047"detects unexpected names and values in `#[cfg]` conditions",
3048 report_in_external_macro
3049}30503051#[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! {
3052/// The `explicit_builtin_cfgs_in_flags` lint detects builtin cfgs set via the `--cfg` flag.
3053 ///
3054 /// ### Example
3055 ///
3056 /// ```text
3057 /// rustc --cfg unix
3058 /// ```
3059 ///
3060 /// ```rust,ignore (needs command line option)
3061 /// fn main() {}
3062 /// ```
3063 ///
3064 /// This will produce:
3065 ///
3066 /// ```text
3067 /// error: unexpected `--cfg unix` flag
3068 /// |
3069 /// = note: config `unix` is only supposed to be controlled by `--target`
3070 /// = note: manually setting a built-in cfg can and does create incoherent behaviors
3071 /// = note: `#[deny(explicit_builtin_cfgs_in_flags)]` on by default
3072 /// ```
3073 ///
3074 /// ### Explanation
3075 ///
3076 /// Setting builtin cfgs can and does produce incoherent behavior, it's better to the use
3077 /// the appropriate `rustc` flag that controls the config. For example setting the `windows`
3078 /// cfg but on Linux based target.
3079pub EXPLICIT_BUILTIN_CFGS_IN_FLAGS,
3080 Deny,
3081"detects builtin cfgs set via the `--cfg`"
3082}30833084#[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! {
3085/// The `repr_transparent_non_zst_fields` lint
3086 /// detects types marked `#[repr(transparent)]` that (transitively)
3087 /// contain a type that is not guaranteed to remain a ZST type under all configurations.
3088 ///
3089 /// ### Example
3090 ///
3091 /// ```rust,ignore (needs external crate)
3092 /// #![deny(repr_transparent_external_private_fields)]
3093 /// use foo::NonExhaustiveZst;
3094 ///
3095 /// #[repr(C)]
3096 /// struct CZst([u8; 0]);
3097 ///
3098 /// #[repr(transparent)]
3099 /// struct Bar(u32, ([u32; 0], NonExhaustiveZst));
3100 /// #[repr(transparent)]
3101 /// struct Baz(u32, CZst);
3102 /// ```
3103 ///
3104 /// This will produce:
3105 ///
3106 /// ```text
3107 /// error: zero-sized fields in repr(transparent) cannot contain external non-exhaustive types
3108 /// --> src/main.rs:5:28
3109 /// |
3110 /// 5 | struct Bar(u32, ([u32; 0], NonExhaustiveZst));
3111 /// | ^^^^^^^^^^^^^^^^
3112 /// |
3113 /// note: the lint level is defined here
3114 /// --> src/main.rs:1:9
3115 /// |
3116 /// 1 | #![deny(repr_transparent_external_private_fields)]
3117 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3118 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3119 /// = note: for more information, see issue #78586 <https://github.com/rust-lang/rust/issues/78586>
3120 /// = note: this field contains `NonExhaustiveZst`, which is marked with `#[non_exhaustive]`, so it could become non-zero-sized in the future.
3121 ///
3122 /// error: zero-sized fields in repr(transparent) cannot contain `#[repr(C)]` types
3123 /// --> src/main.rs:5:28
3124 /// |
3125 /// 5 | struct Baz(u32, CZst);
3126 /// | ^^^^
3127 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3128 /// = note: for more information, see issue #78586 <https://github.com/rust-lang/rust/issues/78586>
3129 /// = note: this field contains `CZst`, which is a `#[repr(C)]` type, so it is not guaranteed to be zero-sized on all targets.
3130 /// ```
3131 ///
3132 /// ### Explanation
3133 ///
3134 /// Previous, Rust accepted fields that contain external private zero-sized types, even though
3135 /// those types could gain a non-zero-sized field in a future, semver-compatible update.
3136 ///
3137 /// Rust also accepted fields that contain `repr(C)` zero-sized types, even though those types
3138 /// are not guaranteed to be zero-sized on all targets, and even though those types can
3139 /// make a difference for the ABI (and therefore cannot be ignored by `repr(transparent)`).
3140 ///
3141 /// This is a [future-incompatible] lint to transition this
3142 /// to a hard error in the future. See [issue #78586] for more details.
3143 ///
3144 /// [issue #78586]: https://github.com/rust-lang/rust/issues/78586
3145 /// [future-incompatible]: ../index.md#future-incompatible-lints
3146pub REPR_TRANSPARENT_NON_ZST_FIELDS,
3147 Deny,
3148"transparent type contains an external ZST that is marked #[non_exhaustive] or contains private fields",
3149 @future_incompatible = FutureIncompatibleInfo {
3150 reason: fcw!(FutureReleaseError #78586),
3151 report_in_deps: true,
3152 };
3153}31543155#[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(feature = "nightly")]"#]
#[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(feature = "nightly")]"#]
#[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 #154045] for more details."]
#[doc = r""]
#[doc = r" [issue #154045]: https://github.com/rust-lang/rust/issues/154045"]
#[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: 154045,
}),
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
3156/// The `unstable_syntax_pre_expansion` lint detects the use of unstable
3157 /// syntax that is discarded during attribute expansion.
3158 ///
3159 /// ### Example
3160 ///
3161 /// ```rust
3162 /// #[cfg(feature = "nightly")]
3163 /// macro foo() {}
3164 /// ```
3165 ///
3166 /// {{produces}}
3167 ///
3168 /// ### Explanation
3169 ///
3170 /// The input to active attributes such as `#[cfg]` or procedural macro
3171 /// attributes is required to be valid syntax. Previously, the compiler only
3172 /// gated the use of unstable syntax features after resolving `#[cfg]` gates
3173 /// and expanding procedural macros.
3174 ///
3175 /// To avoid relying on unstable syntax, move the use of unstable syntax
3176 /// into a position where the compiler does not parse the syntax, such as a
3177 /// functionlike macro.
3178 ///
3179 /// ```rust
3180 /// # #![deny(unstable_syntax_pre_expansion)]
3181 ///
3182 /// macro_rules! identity {
3183 /// ( $($tokens:tt)* ) => { $($tokens)* }
3184 /// }
3185 ///
3186 /// #[cfg(feature = "nightly")]
3187 /// identity! {
3188 /// macro foo() {}
3189 /// }
3190 /// ```
3191 ///
3192 /// This is a [future-incompatible] lint to transition this
3193 /// to a hard error in the future. See [issue #154045] for more details.
3194 ///
3195 /// [issue #154045]: https://github.com/rust-lang/rust/issues/154045
3196 /// [future-incompatible]: ../index.md#future-incompatible-lints
3197pub UNSTABLE_SYNTAX_PRE_EXPANSION,
3198 Warn,
3199"unstable syntax can change at any point in the future, causing a hard error!",
3200 @future_incompatible = FutureIncompatibleInfo {
3201 reason: fcw!(FutureReleaseError #154045),
3202 };
3203}32043205#[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! {
3206/// The `ambiguous_glob_reexports` lint detects cases where names re-exported via globs
3207 /// collide. Downstream users trying to use the same name re-exported from multiple globs
3208 /// will receive a warning pointing out redefinition of the same name.
3209 ///
3210 /// ### Example
3211 ///
3212 /// ```rust,compile_fail
3213 /// #![deny(ambiguous_glob_reexports)]
3214 /// pub mod foo {
3215 /// pub type X = u8;
3216 /// }
3217 ///
3218 /// pub mod bar {
3219 /// pub type Y = u8;
3220 /// pub type X = u8;
3221 /// }
3222 ///
3223 /// pub use foo::*;
3224 /// pub use bar::*;
3225 ///
3226 ///
3227 /// pub fn main() {}
3228 /// ```
3229 ///
3230 /// {{produces}}
3231 ///
3232 /// ### Explanation
3233 ///
3234 /// This was previously accepted but it could silently break a crate's downstream users code.
3235 /// For example, if `foo::*` and `bar::*` were re-exported before `bar::X` was added to the
3236 /// re-exports, down stream users could use `this_crate::X` without problems. However, adding
3237 /// `bar::X` would cause compilation errors in downstream crates because `X` is defined
3238 /// multiple times in the same namespace of `this_crate`.
3239pub AMBIGUOUS_GLOB_REEXPORTS,
3240 Warn,
3241"ambiguous glob re-exports",
3242}32433244#[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! {
3245/// The `hidden_glob_reexports` lint detects cases where glob re-export items are shadowed by
3246 /// private items.
3247 ///
3248 /// ### Example
3249 ///
3250 /// ```rust,compile_fail
3251 /// #![deny(hidden_glob_reexports)]
3252 ///
3253 /// pub mod upstream {
3254 /// mod inner { pub struct Foo {}; pub struct Bar {}; }
3255 /// pub use self::inner::*;
3256 /// struct Foo {} // private item shadows `inner::Foo`
3257 /// }
3258 ///
3259 /// // mod downstream {
3260 /// // fn test() {
3261 /// // let _ = crate::upstream::Foo; // inaccessible
3262 /// // }
3263 /// // }
3264 ///
3265 /// pub fn main() {}
3266 /// ```
3267 ///
3268 /// {{produces}}
3269 ///
3270 /// ### Explanation
3271 ///
3272 /// This was previously accepted without any errors or warnings but it could silently break a
3273 /// crate's downstream user code. If the `struct Foo` was added, `dep::inner::Foo` would
3274 /// silently become inaccessible and trigger a "`struct `Foo` is private`" visibility error at
3275 /// the downstream use site.
3276pub HIDDEN_GLOB_REEXPORTS,
3277 Warn,
3278"name introduced by a private item shadows a name introduced by a public glob re-export",
3279}32803281#[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! {
3282/// The `long_running_const_eval` lint is emitted when const
3283 /// eval is running for a long time to ensure rustc terminates
3284 /// even if you accidentally wrote an infinite loop.
3285 ///
3286 /// ### Example
3287 ///
3288 /// ```rust,compile_fail
3289 /// const FOO: () = loop {};
3290 /// ```
3291 ///
3292 /// {{produces}}
3293 ///
3294 /// ### Explanation
3295 ///
3296 /// Loops allow const evaluation to compute arbitrary code, but may also
3297 /// cause infinite loops or just very long running computations.
3298 /// Users can enable long running computations by allowing the lint
3299 /// on individual constants or for entire crates.
3300 ///
3301 /// ### Unconditional warnings
3302 ///
3303 /// Note that regardless of whether the lint is allowed or set to warn,
3304 /// the compiler will issue warnings if constant evaluation runs significantly
3305 /// longer than this lint's limit. These warnings are also shown to downstream
3306 /// users from crates.io or similar registries. If you are above the lint's limit,
3307 /// both you and downstream users might be exposed to these warnings.
3308 /// They might also appear on compiler updates, as the compiler makes minor changes
3309 /// about how complexity is measured: staying below the limit ensures that there
3310 /// is enough room, and given that the lint is disabled for people who use your
3311 /// dependency it means you will be the only one to get the warning and can put
3312 /// out an update in your own time.
3313pub LONG_RUNNING_CONST_EVAL,
3314 Deny,
3315"detects long const eval operations",
3316 report_in_external_macro
3317}33183319#[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! {
3320/// The `unused_associated_type_bounds` lint is emitted when an
3321 /// associated type bound is added to a trait object, but the associated
3322 /// type has a `where Self: Sized` bound, and is thus unavailable on the
3323 /// trait object anyway.
3324 ///
3325 /// ### Example
3326 ///
3327 /// ```rust
3328 /// trait Foo {
3329 /// type Bar where Self: Sized;
3330 /// }
3331 /// type Mop = dyn Foo<Bar = ()>;
3332 /// ```
3333 ///
3334 /// {{produces}}
3335 ///
3336 /// ### Explanation
3337 ///
3338 /// Just like methods with `Self: Sized` bounds are unavailable on trait
3339 /// objects, associated types can be removed from the trait object.
3340pub UNUSED_ASSOCIATED_TYPE_BOUNDS,
3341 Warn,
3342"detects unused `Foo = Bar` bounds in `dyn Trait<Foo = Bar>`"
3343}33443345#[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! {
3346/// The `unused_doc_comments` lint detects doc comments that aren't used
3347 /// by `rustdoc`.
3348 ///
3349 /// ### Example
3350 ///
3351 /// ```rust
3352 /// /// docs for x
3353 /// let x = 12;
3354 /// ```
3355 ///
3356 /// {{produces}}
3357 ///
3358 /// ### Explanation
3359 ///
3360 /// `rustdoc` does not use doc comments in all positions, and so the doc
3361 /// comment will be ignored. Try changing it to a normal comment with `//`
3362 /// to avoid the warning.
3363pub UNUSED_DOC_COMMENTS,
3364 Warn,
3365"detects doc comments that aren't used by rustdoc"
3366}33673368#[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! {
3369/// The `rust_2021_incompatible_closure_captures` lint detects variables that aren't completely
3370 /// captured in Rust 2021, such that the `Drop` order of their fields may differ between
3371 /// Rust 2018 and 2021.
3372 ///
3373 /// It can also detect when a variable implements a trait like `Send`, but one of its fields does not,
3374 /// and the field is captured by a closure and used with the assumption that said field implements
3375 /// the same trait as the root variable.
3376 ///
3377 /// ### Example of drop reorder
3378 ///
3379 /// ```rust,edition2018,compile_fail
3380 /// #![deny(rust_2021_incompatible_closure_captures)]
3381 /// # #![allow(unused)]
3382 ///
3383 /// struct FancyInteger(i32);
3384 ///
3385 /// impl Drop for FancyInteger {
3386 /// fn drop(&mut self) {
3387 /// println!("Just dropped {}", self.0);
3388 /// }
3389 /// }
3390 ///
3391 /// struct Point { x: FancyInteger, y: FancyInteger }
3392 ///
3393 /// fn main() {
3394 /// let p = Point { x: FancyInteger(10), y: FancyInteger(20) };
3395 ///
3396 /// let c = || {
3397 /// let x = p.x;
3398 /// };
3399 ///
3400 /// c();
3401 ///
3402 /// // ... More code ...
3403 /// }
3404 /// ```
3405 ///
3406 /// {{produces}}
3407 ///
3408 /// ### Explanation
3409 ///
3410 /// In the above example, `p.y` will be dropped at the end of `f` instead of
3411 /// with `c` in Rust 2021.
3412 ///
3413 /// ### Example of auto-trait
3414 ///
3415 /// ```rust,edition2018,compile_fail
3416 /// #![deny(rust_2021_incompatible_closure_captures)]
3417 /// use std::thread;
3418 ///
3419 /// struct Pointer(*mut i32);
3420 /// unsafe impl Send for Pointer {}
3421 ///
3422 /// fn main() {
3423 /// let mut f = 10;
3424 /// let fptr = Pointer(&mut f as *mut i32);
3425 /// thread::spawn(move || unsafe {
3426 /// *fptr.0 = 20;
3427 /// });
3428 /// }
3429 /// ```
3430 ///
3431 /// {{produces}}
3432 ///
3433 /// ### Explanation
3434 ///
3435 /// In the above example, only `fptr.0` is captured in Rust 2021.
3436 /// The field is of type `*mut i32`, which doesn't implement `Send`,
3437 /// making the code invalid as the field cannot be sent between threads safely.
3438pub RUST_2021_INCOMPATIBLE_CLOSURE_CAPTURES,
3439 Allow,
3440"detects closures affected by Rust 2021 changes",
3441 @future_incompatible = FutureIncompatibleInfo {
3442 reason: fcw!(EditionSemanticsChange 2021 "disjoint-capture-in-closures"),
3443 explain_reason: false,
3444 };
3445}34463447pub 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]);
34483449#[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! {
3450/// The `missing_abi` lint detects cases where the ABI is omitted from
3451 /// `extern` declarations.
3452 ///
3453 /// ### Example
3454 ///
3455 /// ```rust,compile_fail
3456 /// #![deny(missing_abi)]
3457 ///
3458 /// extern fn foo() {}
3459 /// ```
3460 ///
3461 /// {{produces}}
3462 ///
3463 /// ### Explanation
3464 ///
3465 /// For historic reasons, Rust implicitly selects `C` as the default ABI for
3466 /// `extern` declarations. [Other ABIs] like `C-unwind` and `system` have
3467 /// been added since then, and especially with their addition seeing the ABI
3468 /// easily makes code review easier.
3469 ///
3470 /// [Other ABIs]: https://doc.rust-lang.org/reference/items/external-blocks.html#abi
3471pub MISSING_ABI,
3472 Warn,
3473"No declared ABI for extern declaration"
3474}34753476#[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! {
3477/// The `invalid_doc_attributes` lint detects when the `#[doc(...)]` is
3478 /// misused.
3479 ///
3480 /// ### Example
3481 ///
3482 /// ```rust,compile_fail
3483 /// #![deny(warnings)]
3484 ///
3485 /// pub mod submodule {
3486 /// #![doc(test(no_crate_inject))]
3487 /// }
3488 /// ```
3489 ///
3490 /// {{produces}}
3491 ///
3492 /// ### Explanation
3493 ///
3494 /// Previously, incorrect usage of the `#[doc(..)]` attribute was not
3495 /// being validated. Usually these should be rejected as a hard error,
3496 /// but this lint was introduced to avoid breaking any existing
3497 /// crates which included them.
3498pub INVALID_DOC_ATTRIBUTES,
3499 Warn,
3500"detects invalid `#[doc(...)]` attributes",
3501}35023503#[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! {
3504/// The `rust_2021_incompatible_or_patterns` lint detects usage of old versions of or-patterns.
3505 ///
3506 /// ### Example
3507 ///
3508 /// ```rust,edition2018,compile_fail
3509 /// #![deny(rust_2021_incompatible_or_patterns)]
3510 ///
3511 /// macro_rules! match_any {
3512 /// ( $expr:expr , $( $( $pat:pat )|+ => $expr_arm:expr ),+ ) => {
3513 /// match $expr {
3514 /// $(
3515 /// $( $pat => $expr_arm, )+
3516 /// )+
3517 /// }
3518 /// };
3519 /// }
3520 ///
3521 /// fn main() {
3522 /// let result: Result<i64, i32> = Err(42);
3523 /// let int: i64 = match_any!(result, Ok(i) | Err(i) => i.into());
3524 /// assert_eq!(int, 42);
3525 /// }
3526 /// ```
3527 ///
3528 /// {{produces}}
3529 ///
3530 /// ### Explanation
3531 ///
3532 /// In Rust 2021, the `pat` matcher will match additional patterns, which include the `|` character.
3533pub RUST_2021_INCOMPATIBLE_OR_PATTERNS,
3534 Allow,
3535"detects usage of old versions of or-patterns",
3536 @future_incompatible = FutureIncompatibleInfo {
3537 reason: fcw!(EditionError 2021 "or-patterns-macro-rules"),
3538 };
3539}35403541#[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! {
3542/// The `rust_2021_prelude_collisions` lint detects the usage of trait methods which are ambiguous
3543 /// with traits added to the prelude in future editions.
3544 ///
3545 /// ### Example
3546 ///
3547 /// ```rust,edition2018,compile_fail
3548 /// #![deny(rust_2021_prelude_collisions)]
3549 ///
3550 /// trait Foo {
3551 /// fn try_into(self) -> Result<String, !>;
3552 /// }
3553 ///
3554 /// impl Foo for &str {
3555 /// fn try_into(self) -> Result<String, !> {
3556 /// Ok(String::from(self))
3557 /// }
3558 /// }
3559 ///
3560 /// fn main() {
3561 /// let x: String = "3".try_into().unwrap();
3562 /// // ^^^^^^^^
3563 /// // This call to try_into matches both Foo::try_into and TryInto::try_into as
3564 /// // `TryInto` has been added to the Rust prelude in 2021 edition.
3565 /// println!("{x}");
3566 /// }
3567 /// ```
3568 ///
3569 /// {{produces}}
3570 ///
3571 /// ### Explanation
3572 ///
3573 /// In Rust 2021, one of the important introductions is the [prelude changes], which add
3574 /// `TryFrom`, `TryInto`, and `FromIterator` into the standard library's prelude. Since this
3575 /// results in an ambiguity as to which method/function to call when an existing `try_into`
3576 /// method is called via dot-call syntax or a `try_from`/`from_iter` associated function
3577 /// is called directly on a type.
3578 ///
3579 /// [prelude changes]: https://blog.rust-lang.org/inside-rust/2021/03/04/planning-rust-2021.html#prelude-changes
3580pub RUST_2021_PRELUDE_COLLISIONS,
3581 Allow,
3582"detects the usage of trait methods which are ambiguous with traits added to the \
3583 prelude in future editions",
3584 @future_incompatible = FutureIncompatibleInfo {
3585 reason: fcw!(EditionError 2021 "prelude"),
3586 };
3587}35883589#[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! {
3590/// The `rust_2024_prelude_collisions` lint detects the usage of trait methods which are ambiguous
3591 /// with traits added to the prelude in future editions.
3592 ///
3593 /// ### Example
3594 ///
3595 /// ```rust,edition2021,compile_fail
3596 /// #![deny(rust_2024_prelude_collisions)]
3597 /// trait Meow {
3598 /// fn poll(&self) {}
3599 /// }
3600 /// impl<T> Meow for T {}
3601 ///
3602 /// fn main() {
3603 /// core::pin::pin!(async {}).poll();
3604 /// // ^^^^^^
3605 /// // This call to try_into matches both Future::poll and Meow::poll as
3606 /// // `Future` has been added to the Rust prelude in 2024 edition.
3607 /// }
3608 /// ```
3609 ///
3610 /// {{produces}}
3611 ///
3612 /// ### Explanation
3613 ///
3614 /// Rust 2024, introduces two new additions to the standard library's prelude:
3615 /// `Future` and `IntoFuture`. This results in an ambiguity as to which method/function
3616 /// to call when an existing `poll`/`into_future` method is called via dot-call syntax or
3617 /// a `poll`/`into_future` associated function is called directly on a type.
3618 ///
3619pub RUST_2024_PRELUDE_COLLISIONS,
3620 Allow,
3621"detects the usage of trait methods which are ambiguous with traits added to the \
3622 prelude in future editions",
3623 @future_incompatible = FutureIncompatibleInfo {
3624 reason: fcw!(EditionError 2024 "prelude"),
3625 };
3626}36273628#[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! {
3629/// The `rust_2021_prefixes_incompatible_syntax` lint detects identifiers that will be parsed as a
3630 /// prefix instead in Rust 2021.
3631 ///
3632 /// ### Example
3633 ///
3634 /// ```rust,edition2018,compile_fail
3635 /// #![deny(rust_2021_prefixes_incompatible_syntax)]
3636 ///
3637 /// macro_rules! m {
3638 /// (z $x:expr) => ();
3639 /// }
3640 ///
3641 /// m!(z"hey");
3642 /// ```
3643 ///
3644 /// {{produces}}
3645 ///
3646 /// ### Explanation
3647 ///
3648 /// In Rust 2015 and 2018, `z"hey"` is two tokens: the identifier `z`
3649 /// followed by the string literal `"hey"`. In Rust 2021, the `z` is
3650 /// considered a prefix for `"hey"`.
3651 ///
3652 /// This lint suggests to add whitespace between the `z` and `"hey"` tokens
3653 /// to keep them separated in Rust 2021.
3654// Allow this lint -- rustdoc doesn't yet support threading edition into this lint's parser.
3655#[allow(rustdoc::invalid_rust_codeblocks)]
3656pub RUST_2021_PREFIXES_INCOMPATIBLE_SYNTAX,
3657 Allow,
3658"identifiers that will be parsed as a prefix in Rust 2021",
3659 @future_incompatible = FutureIncompatibleInfo {
3660 reason: fcw!(EditionError 2021 "reserving-syntax"),
3661 };
3662 crate_level_only
3663}36643665#[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! {
3666/// The `unsupported_calling_conventions` lint is output whenever there is a use of the
3667 /// `stdcall`, `fastcall`, and `cdecl` calling conventions (or their unwind
3668 /// variants) on targets that cannot meaningfully be supported for the requested target.
3669 ///
3670 /// For example, `stdcall` does not make much sense for a x86_64 or, more apparently, powerpc
3671 /// code, because this calling convention was never specified for those targets.
3672 ///
3673 /// Historically, MSVC toolchains have fallen back to the regular C calling convention for
3674 /// targets other than x86, but Rust doesn't really see a similar need to introduce a similar
3675 /// hack across many more targets.
3676 ///
3677 /// ### Example
3678 ///
3679 /// ```rust,ignore (needs specific targets)
3680 /// extern "stdcall" fn stdcall() {}
3681 /// ```
3682 ///
3683 /// This will produce:
3684 ///
3685 /// ```text
3686 /// warning: use of calling convention not supported on this target
3687 /// --> $DIR/unsupported.rs:39:1
3688 /// |
3689 /// LL | extern "stdcall" fn stdcall() {}
3690 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3691 /// |
3692 /// = note: `#[warn(unsupported_calling_conventions)]` on by default
3693 /// = warning: this was previously accepted by the compiler but is being phased out;
3694 /// it will become a hard error in a future release!
3695 /// = note: for more information, see issue ...
3696 /// ```
3697 ///
3698 /// ### Explanation
3699 ///
3700 /// On most of the targets, the behaviour of `stdcall` and similar calling conventions is not
3701 /// defined at all, but was previously accepted due to a bug in the implementation of the
3702 /// compiler.
3703pub UNSUPPORTED_CALLING_CONVENTIONS,
3704 Warn,
3705"use of unsupported calling convention",
3706 @future_incompatible = FutureIncompatibleInfo {
3707 reason: fcw!(FutureReleaseError #137018),
3708 report_in_deps: false,
3709 };
3710}37113712#[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! {
3713/// The `unsupported_fn_ptr_calling_conventions` lint is output whenever there is a use of
3714 /// a target dependent calling convention on a target that does not support this calling
3715 /// convention on a function pointer.
3716 ///
3717 /// For example `stdcall` does not make much sense for a x86_64 or, more apparently, powerpc
3718 /// code, because this calling convention was never specified for those targets.
3719 ///
3720 /// ### Example
3721 ///
3722 /// ```rust,ignore (needs specific targets)
3723 /// fn stdcall_ptr(f: extern "stdcall" fn ()) {
3724 /// f()
3725 /// }
3726 /// ```
3727 ///
3728 /// This will produce:
3729 ///
3730 /// ```text
3731 /// warning: the calling convention `"stdcall"` is not supported on this target
3732 /// --> $DIR/unsupported.rs:34:15
3733 /// |
3734 /// LL | fn stdcall_ptr(f: extern "stdcall" fn()) {
3735 /// | ^^^^^^^^^^^^^^^^^^^^^^^^
3736 /// |
3737 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
3738 /// = note: for more information, see issue #130260 <https://github.com/rust-lang/rust/issues/130260>
3739 /// = note: `#[warn(unsupported_fn_ptr_calling_conventions)]` on by default
3740 /// ```
3741 ///
3742 /// ### Explanation
3743 ///
3744 /// On most of the targets the behaviour of `stdcall` and similar calling conventions is not
3745 /// defined at all, but was previously accepted due to a bug in the implementation of the
3746 /// compiler.
3747pub UNSUPPORTED_FN_PTR_CALLING_CONVENTIONS,
3748 Warn,
3749"use of unsupported calling convention for function pointer",
3750 @future_incompatible = FutureIncompatibleInfo {
3751 reason: fcw!(FutureReleaseError #130260),
3752 report_in_deps: true,
3753 };
3754}37553756#[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! {
3757/// The `break_with_label_and_loop` lint detects labeled `break` expressions with
3758 /// an unlabeled loop as their value expression.
3759 ///
3760 /// ### Example
3761 ///
3762 /// ```rust
3763 /// 'label: loop {
3764 /// break 'label loop { break 42; };
3765 /// };
3766 /// ```
3767 ///
3768 /// {{produces}}
3769 ///
3770 /// ### Explanation
3771 ///
3772 /// In Rust, loops can have a label, and `break` expressions can refer to that label to
3773 /// break out of specific loops (and not necessarily the innermost one). `break` expressions
3774 /// can also carry a value expression, which can be another loop. A labeled `break` with an
3775 /// unlabeled loop as its value expression is easy to confuse with an unlabeled break with
3776 /// a labeled loop and is thus discouraged (but allowed for compatibility); use parentheses
3777 /// around the loop expression to silence this warning. Unlabeled `break` expressions with
3778 /// labeled loops yield a hard error, which can also be silenced by wrapping the expression
3779 /// in parentheses.
3780pub BREAK_WITH_LABEL_AND_LOOP,
3781 Warn,
3782"`break` expression with label and unlabeled loop as value expression"
3783}37843785#[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! {
3786/// The `non_exhaustive_omitted_patterns` lint aims to help consumers of a `#[non_exhaustive]`
3787 /// struct or enum who want to match all of its fields/variants explicitly.
3788 ///
3789 /// The `#[non_exhaustive]` annotation forces matches to use wildcards, so exhaustiveness
3790 /// checking cannot be used to ensure that all fields/variants are matched explicitly. To remedy
3791 /// this, this allow-by-default lint warns the user when a match mentions some but not all of
3792 /// the fields/variants of a `#[non_exhaustive]` struct or enum.
3793 ///
3794 /// ### Example
3795 ///
3796 /// ```rust,ignore (needs separate crate)
3797 /// // crate A
3798 /// #[non_exhaustive]
3799 /// pub enum Bar {
3800 /// A,
3801 /// B, // added variant in non breaking change
3802 /// }
3803 ///
3804 /// // in crate B
3805 /// #![feature(non_exhaustive_omitted_patterns_lint)]
3806 /// #[warn(non_exhaustive_omitted_patterns)]
3807 /// match Bar::A {
3808 /// Bar::A => {},
3809 /// _ => {},
3810 /// }
3811 /// ```
3812 ///
3813 /// This will produce:
3814 ///
3815 /// ```text
3816 /// warning: some variants are not matched explicitly
3817 /// --> $DIR/reachable-patterns.rs:70:9
3818 /// |
3819 /// LL | match Bar::A {
3820 /// | ^ pattern `Bar::B` not covered
3821 /// |
3822 /// note: the lint level is defined here
3823 /// --> $DIR/reachable-patterns.rs:69:16
3824 /// |
3825 /// LL | #[warn(non_exhaustive_omitted_patterns)]
3826 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3827 /// = help: ensure that all variants are matched explicitly by adding the suggested match arms
3828 /// = note: the matched value is of type `Bar` and the `non_exhaustive_omitted_patterns` attribute was found
3829 /// ```
3830 ///
3831 /// Warning: setting this to `deny` will make upstream non-breaking changes (adding fields or
3832 /// variants to a `#[non_exhaustive]` struct or enum) break your crate. This goes against
3833 /// expected semver behavior.
3834 ///
3835 /// ### Explanation
3836 ///
3837 /// Structs and enums tagged with `#[non_exhaustive]` force the user to add a (potentially
3838 /// redundant) wildcard when pattern-matching, to allow for future addition of fields or
3839 /// variants. The `non_exhaustive_omitted_patterns` lint detects when such a wildcard happens to
3840 /// actually catch some fields/variants. In other words, when the match without the wildcard
3841 /// would not be exhaustive. This lets the user be informed if new fields/variants were added.
3842pub NON_EXHAUSTIVE_OMITTED_PATTERNS,
3843 Allow,
3844"detect when patterns of types marked `non_exhaustive` are missed",
3845 @feature_gate = non_exhaustive_omitted_patterns_lint;
3846}38473848#[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! {
3849/// The `text_direction_codepoint_in_comment` lint detects Unicode codepoints in comments that
3850 /// change the visual representation of text on screen in a way that does not correspond to
3851 /// their on memory representation.
3852 ///
3853 /// ### Example
3854 ///
3855 /// ```rust,compile_fail
3856 /// #![deny(text_direction_codepoint_in_comment)]
3857 /// fn main() {
3858#[doc = " println!(\"{:?}\"); // '\u{202E}');"]
3859/// }
3860 /// ```
3861 ///
3862 /// {{produces}}
3863 ///
3864 /// ### Explanation
3865 ///
3866 /// Unicode allows changing the visual flow of text on screen in order to support scripts that
3867 /// are written right-to-left, but a specially crafted comment can make code that will be
3868 /// compiled appear to be part of a comment, depending on the software used to read the code.
3869 /// To avoid potential problems or confusion, such as in CVE-2021-42574, by default we deny
3870 /// their use.
3871pub TEXT_DIRECTION_CODEPOINT_IN_COMMENT,
3872 Deny,
3873"invisible directionality-changing codepoints in comment",
3874 crate_level_only
3875}38763877#[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! {
3878/// The `text_direction_codepoint_in_literal` lint detects Unicode codepoints that change the
3879 /// visual representation of text on screen in a way that does not correspond to their on
3880 /// memory representation.
3881 ///
3882 /// ### Explanation
3883 ///
3884 /// The unicode characters `\u{202A}`, `\u{202B}`, `\u{202D}`, `\u{202E}`, `\u{2066}`,
3885 /// `\u{2067}`, `\u{2068}`, `\u{202C}` and `\u{2069}` make the flow of text on screen change
3886 /// its direction on software that supports these codepoints. This makes the text "abc" display
3887 /// as "cba" on screen. By leveraging software that supports these, people can write specially
3888 /// crafted literals that make the surrounding code seem like it's performing one action, when
3889 /// in reality it is performing another. Because of this, we proactively lint against their
3890 /// presence to avoid surprises.
3891 ///
3892 /// ### Example
3893 ///
3894 /// ```rust,compile_fail
3895 /// #![deny(text_direction_codepoint_in_literal)]
3896 /// fn main() {
3897// ` - convince tidy that backticks match
3898#[doc = " println!(\"{:?}\", '\u{202E}');"]
3899// `
3900/// }
3901 /// ```
3902 ///
3903 /// {{produces}}
3904 ///
3905pub TEXT_DIRECTION_CODEPOINT_IN_LITERAL,
3906 Deny,
3907"detect special Unicode codepoints that affect the visual representation of text on screen, \
3908 changing the direction in which text flows",
3909 crate_level_only
3910}39113912#[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! {
3913/// The `duplicate_macro_attributes` lint detects when a `#[test]`-like built-in macro
3914 /// attribute is duplicated on an item. This lint may trigger on `bench`, `cfg_eval`, `test`
3915 /// and `test_case`.
3916 ///
3917 /// ### Example
3918 ///
3919 /// ```rust,ignore (needs --test)
3920 /// #[test]
3921 /// #[test]
3922 /// fn foo() {}
3923 /// ```
3924 ///
3925 /// This will produce:
3926 ///
3927 /// ```text
3928 /// warning: duplicated attribute
3929 /// --> src/lib.rs:2:1
3930 /// |
3931 /// 2 | #[test]
3932 /// | ^^^^^^^
3933 /// |
3934 /// = note: `#[warn(duplicate_macro_attributes)]` on by default
3935 /// ```
3936 ///
3937 /// ### Explanation
3938 ///
3939 /// A duplicated attribute may erroneously originate from a copy-paste and the effect of it
3940 /// being duplicated may not be obvious or desirable.
3941 ///
3942 /// For instance, doubling the `#[test]` attributes registers the test to be run twice with no
3943 /// change to its environment.
3944 ///
3945 /// [issue #90979]: https://github.com/rust-lang/rust/issues/90979
3946pub DUPLICATE_MACRO_ATTRIBUTES,
3947 Warn,
3948"duplicated attribute"
3949}39503951#[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! {
3952/// The `deprecated_where_clause_location` lint detects when a where clause in front of the equals
3953 /// in an associated type.
3954 ///
3955 /// ### Example
3956 ///
3957 /// ```rust
3958 /// trait Trait {
3959 /// type Assoc<'a> where Self: 'a;
3960 /// }
3961 ///
3962 /// impl Trait for () {
3963 /// type Assoc<'a> where Self: 'a = ();
3964 /// }
3965 /// ```
3966 ///
3967 /// {{produces}}
3968 ///
3969 /// ### Explanation
3970 ///
3971 /// The preferred location for where clauses on associated types
3972 /// is after the type. However, for most of generic associated types development,
3973 /// it was only accepted before the equals. To provide a transition period and
3974 /// further evaluate this change, both are currently accepted. At some point in
3975 /// the future, this may be disallowed at an edition boundary; but, that is
3976 /// undecided currently.
3977pub DEPRECATED_WHERE_CLAUSE_LOCATION,
3978 Warn,
3979"deprecated where clause location"
3980}39813982#[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! {
3983/// The `test_unstable_lint` lint tests unstable lints and is perma-unstable.
3984 ///
3985 /// ### Example
3986 ///
3987 /// ```rust
3988 /// // This lint is intentionally used to test the compiler's behavior
3989 /// // when an unstable lint is enabled without the corresponding feature gate.
3990 /// #![allow(test_unstable_lint)]
3991 /// ```
3992 ///
3993 /// {{produces}}
3994 ///
3995 /// ### Explanation
3996 ///
3997 /// In order to test the behavior of unstable lints, a permanently-unstable
3998 /// lint is required. This lint can be used to trigger warnings and errors
3999 /// from the compiler related to unstable lints.
4000pub TEST_UNSTABLE_LINT,
4001 Deny,
4002"this unstable lint is only for testing",
4003 @feature_gate = test_unstable_lint;
4004}40054006#[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! {
4007/// The `ffi_unwind_calls` lint detects calls to foreign functions or function pointers with
4008 /// `C-unwind` or other FFI-unwind ABIs.
4009 ///
4010 /// ### Example
4011 ///
4012 /// ```rust
4013 /// #![warn(ffi_unwind_calls)]
4014 ///
4015 /// unsafe extern "C-unwind" {
4016 /// fn foo();
4017 /// }
4018 ///
4019 /// fn bar() {
4020 /// unsafe { foo(); }
4021 /// let ptr: unsafe extern "C-unwind" fn() = foo;
4022 /// unsafe { ptr(); }
4023 /// }
4024 /// ```
4025 ///
4026 /// {{produces}}
4027 ///
4028 /// ### Explanation
4029 ///
4030 /// For crates containing such calls, if they are compiled with `-C panic=unwind` then the
4031 /// produced library cannot be linked with crates compiled with `-C panic=abort`. For crates
4032 /// that desire this ability it is therefore necessary to avoid such calls.
4033pub FFI_UNWIND_CALLS,
4034 Allow,
4035"call to foreign functions or function pointers with FFI-unwind ABI"
4036}40374038#[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! {
4039/// The `linker_messages` lint forwards warnings from the linker.
4040 ///
4041 /// ### Example
4042 ///
4043 /// ```rust,ignore (needs CLI args, platform-specific)
4044 /// #[warn(linker_messages)]
4045 /// extern "C" {
4046 /// fn foo();
4047 /// }
4048 /// fn main () { unsafe { foo(); } }
4049 /// ```
4050 ///
4051 /// On Linux, using `gcc -Wl,--warn-unresolved-symbols` as a linker, this will produce
4052 ///
4053 /// ```text
4054 /// warning: linker stderr: rust-lld: undefined symbol: foo
4055 /// >>> referenced by rust_out.69edbd30df4ae57d-cgu.0
4056 /// >>> rust_out.rust_out.69edbd30df4ae57d-cgu.0.rcgu.o:(rust_out::main::h3a90094b06757803)
4057 /// |
4058 /// note: the lint level is defined here
4059 /// --> warn.rs:1:9
4060 /// |
4061 /// 1 | #![warn(linker_messages)]
4062 /// | ^^^^^^^^^^^^^^^
4063 /// warning: 1 warning emitted
4064 /// ```
4065 ///
4066 /// ### Explanation
4067 ///
4068 /// Linkers emit platform-specific and program-specific warnings that cannot be predicted in
4069 /// advance by the Rust compiler. Such messages are ignored by default for now. While linker
4070 /// warnings could be very useful they have been ignored for many years by essentially all
4071 /// users, so we need to do a bit more work than just surfacing their text to produce a clear
4072 /// and actionable warning of similar quality to our other diagnostics. See this tracking
4073 /// issue for more details: <https://github.com/rust-lang/rust/issues/136096>.
4074pub LINKER_MESSAGES,
4075 Allow,
4076"warnings emitted at runtime by the target-specific linker program"
4077}40784079#[doc =
r" The `linker_info` lint forwards warnings from the linker that are known to be informational-only."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (needs CLI args, platform-specific)"]
#[doc = r" #[warn(linker_info)]"]
#[doc = r" fn main () {}"]
#[doc = r" ```"]
#[doc = r""]
#[doc =
r" On MacOS, using `-C link-arg=-lc` and the default linker, this will produce"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" warning: linker stderr: ld: ignoring duplicate libraries: '-lc'"]
#[doc = r" |"]
#[doc = r" note: the lint level is defined here"]
#[doc = r" --> ex.rs:1:9"]
#[doc = r" |"]
#[doc = r" 1 | #![warn(linker_info)]"]
#[doc = r" | ^^^^^^^^^^^^^^^"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r#" Many linkers are very "chatty" and print lots of information that is not necessarily"#]
#[doc =
r" indicative of an issue. This output has been ignored for many years and is often not"]
#[doc =
r" actionable by developers. It is silenced unless the developer specifically requests for it"]
#[doc = r" to be printed. See this tracking issue for more details:"]
#[doc = r" <https://github.com/rust-lang/rust/issues/136096>."]
pub static LINKER_INFO: &crate::Lint =
&crate::Lint {
name: "LINKER_INFO",
default_level: crate::Allow,
desc: "linker warnings known to be informational-only and not indicative of a problem",
is_externally_loaded: false,
..crate::Lint::default_fields_for_macro()
};declare_lint! {
4080/// The `linker_info` lint forwards warnings from the linker that are known to be informational-only.
4081 ///
4082 /// ### Example
4083 ///
4084 /// ```rust,ignore (needs CLI args, platform-specific)
4085 /// #[warn(linker_info)]
4086 /// fn main () {}
4087 /// ```
4088 ///
4089 /// On MacOS, using `-C link-arg=-lc` and the default linker, this will produce
4090 ///
4091 /// ```text
4092 /// warning: linker stderr: ld: ignoring duplicate libraries: '-lc'
4093 /// |
4094 /// note: the lint level is defined here
4095 /// --> ex.rs:1:9
4096 /// |
4097 /// 1 | #![warn(linker_info)]
4098 /// | ^^^^^^^^^^^^^^^
4099 /// ```
4100 ///
4101 /// ### Explanation
4102 ///
4103 /// Many linkers are very "chatty" and print lots of information that is not necessarily
4104 /// indicative of an issue. This output has been ignored for many years and is often not
4105 /// actionable by developers. It is silenced unless the developer specifically requests for it
4106 /// to be printed. See this tracking issue for more details:
4107 /// <https://github.com/rust-lang/rust/issues/136096>.
4108pub LINKER_INFO,
4109 Allow,
4110"linker warnings known to be informational-only and not indicative of a problem"
4111}41124113#[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! {
4114/// The `named_arguments_used_positionally` lint detects cases where named arguments are only
4115 /// used positionally in format strings. This usage is valid but potentially very confusing.
4116 ///
4117 /// ### Example
4118 ///
4119 /// ```rust,compile_fail
4120 /// #![deny(named_arguments_used_positionally)]
4121 /// fn main() {
4122 /// let _x = 5;
4123 /// println!("{}", _x = 1); // Prints 1, will trigger lint
4124 ///
4125 /// println!("{}", _x); // Prints 5, no lint emitted
4126 /// println!("{_x}", _x = _x); // Prints 5, no lint emitted
4127 /// }
4128 /// ```
4129 ///
4130 /// {{produces}}
4131 ///
4132 /// ### Explanation
4133 ///
4134 /// Rust formatting strings can refer to named arguments by their position, but this usage is
4135 /// potentially confusing. In particular, readers can incorrectly assume that the declaration
4136 /// of named arguments is an assignment (which would produce the unit type).
4137 /// For backwards compatibility, this is not a hard error.
4138pub NAMED_ARGUMENTS_USED_POSITIONALLY,
4139 Warn,
4140"named arguments in format used positionally"
4141}41424143#[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! {
4144/// The `never_type_fallback_flowing_into_unsafe` lint detects cases where never type fallback
4145 /// affects unsafe function calls.
4146 ///
4147 /// ### Never type fallback
4148 ///
4149 /// When the compiler sees a value of type [`!`] it implicitly inserts a coercion (if possible),
4150 /// to allow type check to infer any type:
4151 ///
4152 /// ```ignore (illustrative-and-has-placeholders)
4153 /// // this
4154 /// let x: u8 = panic!();
4155 ///
4156 /// // is (essentially) turned by the compiler into
4157 /// let x: u8 = absurd(panic!());
4158 ///
4159 /// // where absurd is a function with the following signature
4160 /// // (it's sound, because `!` always marks unreachable code):
4161 /// fn absurd<T>(never: !) -> T { ... }
4162 /// ```
4163 ///
4164 /// While it's convenient to be able to use non-diverging code in one of the branches (like
4165 /// `if a { b } else { return }`) this could lead to compilation errors:
4166 ///
4167 /// ```compile_fail
4168 /// // this
4169 /// { panic!() };
4170 ///
4171 /// // gets turned into this
4172 /// { absurd(panic!()) }; // error: can't infer the type of `absurd`
4173 /// ```
4174 ///
4175 /// To prevent such errors, compiler remembers where it inserted `absurd` calls, and if it
4176 /// can't infer their type, it sets the type to fallback. `{ absurd::<Fallback>(panic!()) };`.
4177 /// This is what is known as "never type fallback".
4178 ///
4179 /// ### Example
4180 ///
4181 /// ```rust,compile_fail
4182 /// fn main() {
4183 /// if true {
4184 /// // return has type `!` which, is some cases, causes never type fallback
4185 /// return
4186 /// } else {
4187 /// // `zeroed` is an unsafe function, which returns an unbounded type
4188 /// unsafe { std::mem::zeroed() }
4189 /// };
4190 /// // depending on the fallback, `zeroed` may create `()` (which is completely sound),
4191 /// // or `!` (which is instant undefined behavior)
4192 /// }
4193 /// ```
4194 ///
4195 /// {{produces}}
4196 ///
4197 /// ### Explanation
4198 ///
4199 /// Due to historic reasons never type fallback was `()`, meaning that `!` got spontaneously
4200 /// coerced to `()`. There are plans to change that, but they may make the code such as above
4201 /// unsound. Instead of depending on the fallback, you should specify the type explicitly:
4202 /// ```
4203 /// if true {
4204 /// return
4205 /// } else {
4206 /// // type is explicitly specified, fallback can't hurt us no more
4207 /// unsafe { std::mem::zeroed::<()>() }
4208 /// };
4209 /// ```
4210 ///
4211 /// See [Tracking Issue for making `!` fall back to `!`](https://github.com/rust-lang/rust/issues/123748).
4212 ///
4213 /// [`!`]: https://doc.rust-lang.org/core/primitive.never.html
4214 /// [`()`]: https://doc.rust-lang.org/core/primitive.unit.html
4215pub NEVER_TYPE_FALLBACK_FLOWING_INTO_UNSAFE,
4216 Deny,
4217"never type fallback affecting unsafe function calls",
4218 @future_incompatible = FutureIncompatibleInfo {
4219 reason: fcw!(EditionAndFutureReleaseSemanticsChange 2024 "never-type-fallback"),
4220 report_in_deps: true,
4221 };
4222 @edition Edition2024 => Deny;
4223 report_in_external_macro
4224}42254226#[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! {
4227/// The `dependency_on_unit_never_type_fallback` lint detects cases where code compiles with
4228 /// [never type fallback] being [`()`], but will stop compiling with fallback being [`!`].
4229 ///
4230 /// [never type fallback]: https://doc.rust-lang.org/nightly/core/primitive.never.html#never-type-fallback
4231 /// [`!`]: https://doc.rust-lang.org/core/primitive.never.html
4232 /// [`()`]: https://doc.rust-lang.org/core/primitive.unit.html
4233 ///
4234 /// ### Example
4235 ///
4236 /// ```rust,compile_fail,edition2021
4237 /// # #![deny(dependency_on_unit_never_type_fallback)]
4238 /// fn main() {
4239 /// if true {
4240 /// // return has type `!` which, is some cases, causes never type fallback
4241 /// return
4242 /// } else {
4243 /// // the type produced by this call is not specified explicitly,
4244 /// // so it will be inferred from the previous branch
4245 /// Default::default()
4246 /// };
4247 /// // depending on the fallback, this may compile (because `()` implements `Default`),
4248 /// // or it may not (because `!` does not implement `Default`)
4249 /// }
4250 /// ```
4251 ///
4252 /// {{produces}}
4253 ///
4254 /// ### Explanation
4255 ///
4256 /// Due to historic reasons never type fallback was `()`, meaning that `!` got spontaneously
4257 /// coerced to `()`. There are plans to change that, but they may make the code such as above
4258 /// not compile. Instead of depending on the fallback, you should specify the type explicitly:
4259 /// ```
4260 /// if true {
4261 /// return
4262 /// } else {
4263 /// // type is explicitly specified, fallback can't hurt us no more
4264 /// <() as Default>::default()
4265 /// };
4266 /// ```
4267 ///
4268 /// See [Tracking Issue for making `!` fall back to `!`](https://github.com/rust-lang/rust/issues/123748).
4269pub DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK,
4270 Deny,
4271"never type fallback affecting unsafe function calls",
4272 @future_incompatible = FutureIncompatibleInfo {
4273 reason: fcw!(EditionAndFutureReleaseError 2024 "never-type-fallback"),
4274 report_in_deps: true,
4275 };
4276 report_in_external_macro
4277}42784279#[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! {
4280/// The `invalid_macro_export_arguments` lint detects cases where `#[macro_export]` is being used with invalid arguments.
4281 ///
4282 /// ### Example
4283 ///
4284 /// ```rust,compile_fail
4285 /// #![deny(invalid_macro_export_arguments)]
4286 ///
4287 /// #[macro_export(invalid_parameter)]
4288 /// macro_rules! myMacro {
4289 /// () => {
4290 /// // [...]
4291 /// }
4292 /// }
4293 ///
4294 /// #[macro_export(too, many, items)]
4295 /// ```
4296 ///
4297 /// {{produces}}
4298 ///
4299 /// ### Explanation
4300 ///
4301 /// The only valid argument is `#[macro_export(local_inner_macros)]` or no argument (`#[macro_export]`).
4302 /// You can't have multiple arguments in a `#[macro_export(..)]`, or mention arguments other than `local_inner_macros`.
4303 ///
4304pub INVALID_MACRO_EXPORT_ARGUMENTS,
4305 Deny,
4306"\"invalid_parameter\" isn't a valid argument for `#[macro_export]`",
4307 @future_incompatible = FutureIncompatibleInfo {
4308 reason: fcw!(FutureReleaseError #57571),
4309 report_in_deps: true,
4310 };
4311}43124313#[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! {
4314/// The `ambiguous_derive_helpers` lint detects cases where a derive macro's helper attribute
4315 /// is the same name as that of a built-in attribute.
4316 ///
4317 /// ### Example
4318 ///
4319 /// ```rust,ignore (proc-macro)
4320 /// #![crate_type = "proc-macro"]
4321 /// #![deny(ambiguous_derive_helpers)]
4322 ///
4323 /// use proc_macro::TokenStream;
4324 ///
4325 /// #[proc_macro_derive(Trait, attributes(ignore))]
4326 /// pub fn example(input: TokenStream) -> TokenStream {
4327 /// TokenStream::new()
4328 /// }
4329 /// ```
4330 ///
4331 /// Produces:
4332 ///
4333 /// ```text
4334 /// warning: there exists a built-in attribute with the same name
4335 /// --> file.rs:5:39
4336 /// |
4337 /// 5 | #[proc_macro_derive(Trait, attributes(ignore))]
4338 /// | ^^^^^^
4339 /// |
4340 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
4341 /// = note: for more information, see issue #151152 <https://github.com/rust-lang/rust/issues/151152>
4342 /// = note: `#[deny(ambiguous_derive_helpers)]` (part of `#[deny(future_incompatible)]`) on by default
4343 /// ```
4344 ///
4345 /// ### Explanation
4346 ///
4347 /// Attempting to use this helper attribute will throw an error:
4348 ///
4349 /// ```rust,ignore (needs-dependency)
4350 /// #[derive(Trait)]
4351 /// struct Example {
4352 /// #[ignore]
4353 /// fields: ()
4354 /// }
4355 /// ```
4356 ///
4357 /// Produces:
4358 ///
4359 /// ```text
4360 /// error[E0659]: `ignore` is ambiguous
4361 /// --> src/lib.rs:5:7
4362 /// |
4363 /// 5 | #[ignore]
4364 /// | ^^^^^^ ambiguous name
4365 /// |
4366 /// = note: ambiguous because of a name conflict with a builtin attribute
4367 /// = note: `ignore` could refer to a built-in attribute
4368 /// note: `ignore` could also refer to the derive helper attribute defined here
4369 /// --> src/lib.rs:3:10
4370 /// |
4371 /// 3 | #[derive(Trait)]
4372 /// | ^^^^^
4373 /// ```
4374pub AMBIGUOUS_DERIVE_HELPERS,
4375 Warn,
4376"detects derive helper attributes that are ambiguous with built-in attributes",
4377 @future_incompatible = FutureIncompatibleInfo {
4378 reason: fcw!(FutureReleaseError #151276),
4379 };
4380}43814382#[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! {
4383/// The `private_interfaces` lint detects types in a primary interface of an item,
4384 /// that are more private than the item itself. Primary interface of an item is all
4385 /// its interface except for bounds on generic parameters and where clauses.
4386 ///
4387 /// ### Example
4388 ///
4389 /// ```rust,compile_fail
4390 /// # #![allow(unused)]
4391 /// #![deny(private_interfaces)]
4392 /// struct SemiPriv;
4393 ///
4394 /// mod m1 {
4395 /// struct Priv;
4396 /// impl crate::SemiPriv {
4397 /// pub fn f(_: Priv) {}
4398 /// }
4399 /// }
4400 ///
4401 /// # fn main() {}
4402 /// ```
4403 ///
4404 /// {{produces}}
4405 ///
4406 /// ### Explanation
4407 ///
4408 /// Having something private in primary interface guarantees that
4409 /// the item will be unusable from outer modules due to type privacy.
4410pub PRIVATE_INTERFACES,
4411 Warn,
4412"private type in primary interface of an item",
4413}44144415#[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! {
4416/// The `private_bounds` lint detects types in a secondary interface of an item,
4417 /// that are more private than the item itself. Secondary interface of an item consists of
4418 /// bounds on generic parameters and where clauses, including supertraits for trait items.
4419 ///
4420 /// ### Example
4421 ///
4422 /// ```rust,compile_fail
4423 /// # #![allow(unused)]
4424 /// #![deny(private_bounds)]
4425 ///
4426 /// struct PrivTy;
4427 /// pub struct S
4428 /// where PrivTy:
4429 /// {}
4430 /// # fn main() {}
4431 /// ```
4432 ///
4433 /// {{produces}}
4434 ///
4435 /// ### Explanation
4436 ///
4437 /// Having private types or traits in item bounds makes it less clear what interface
4438 /// the item actually provides.
4439pub PRIVATE_BOUNDS,
4440 Warn,
4441"private type in secondary interface of an item",
4442}44434444#[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! {
4445/// The `unnameable_types` lint detects types for which you can get objects of that type,
4446 /// but cannot name the type itself.
4447 ///
4448 /// ### Example
4449 ///
4450 /// ```rust,compile_fail
4451 /// # #![allow(unused)]
4452 /// #![deny(unnameable_types)]
4453 /// mod m {
4454 /// pub struct S;
4455 /// }
4456 ///
4457 /// pub fn get_unnameable() -> m::S { m::S }
4458 /// # fn main() {}
4459 /// ```
4460 ///
4461 /// {{produces}}
4462 ///
4463 /// ### Explanation
4464 ///
4465 /// It is often expected that if you can obtain an object of type `T`, then
4466 /// you can name the type `T` as well; this lint attempts to enforce this rule.
4467 /// The recommended action is to either reexport the type properly to make it nameable,
4468 /// or document that users are not supposed to be able to name it for one reason or another.
4469 ///
4470 /// Besides types, this lint applies to traits because traits can also leak through signatures,
4471 /// and you may obtain objects of their `dyn Trait` or `impl Trait` types.
4472pub UNNAMEABLE_TYPES,
4473 Allow,
4474"effective visibility of a type is larger than the area in which it can be named",
4475}44764477#[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! {
4478/// The `malformed_diagnostic_attributes` lint detects malformed diagnostic attributes.
4479 ///
4480 /// ### Example
4481 ///
4482 /// ```rust
4483 /// #[diagnostic::do_not_recommend(message = "message")]
4484 /// trait Trait {}
4485 /// ```
4486 ///
4487 /// {{produces}}
4488 ///
4489 /// ### Explanation
4490 ///
4491 /// It is usually a mistake to use options or syntax that is not supported. Check the spelling,
4492 /// and check the diagnostic attribute listing for the correct name and syntax. Also consider if
4493 /// you are using an old version of the compiler; perhaps the option or syntax is only available
4494 /// in a newer version. See the [reference] for a list of diagnostic attributes and the syntax
4495 /// of each.
4496 ///
4497 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4498pub MALFORMED_DIAGNOSTIC_ATTRIBUTES,
4499 Warn,
4500"detects malformed diagnostic attributes",
4501}45024503#[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! {
4504/// The `misplaced_diagnostic_attributes` lint detects wrongly placed diagnostic attributes.
4505 ///
4506 /// ### Example
4507 ///
4508 /// ```rust
4509 /// #[diagnostic::do_not_recommend]
4510 /// struct NotUserFacing;
4511 /// ```
4512 ///
4513 /// {{produces}}
4514 ///
4515 /// ### Explanation
4516 ///
4517 /// It is usually a mistake to specify a diagnostic attribute on an item it is not meant for.
4518 /// For example, `#[diagnostic::do_not_recommend]` can only be placed on trait implementations,
4519 /// and does nothing if placed elsewhere. See the [reference] for a list of diagnostic
4520 /// attributes and their correct positions.
4521 ///
4522 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4523pub MISPLACED_DIAGNOSTIC_ATTRIBUTES,
4524 Warn,
4525"detects diagnostic attributes that are placed on the wrong item",
4526}45274528#[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! {
4529/// The `unknown_diagnostic_attributes` lint detects unknown diagnostic attributes.
4530 ///
4531 /// ### Example
4532 ///
4533 /// ```rust
4534 /// #[diagnostic::does_not_exist]
4535 /// struct Thing;
4536 /// ```
4537 ///
4538 /// {{produces}}
4539 ///
4540 /// ### Explanation
4541 ///
4542 /// It is usually a mistake to specify a diagnostic attribute that does not exist. Check the
4543 /// spelling, and check the diagnostic attribute listing for the correct name. Also consider if
4544 /// you are using an old version of the compiler and the attribute is only available in a newer
4545 /// version. See the [reference] for the list of diagnostic attributes.
4546 ///
4547 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4548pub UNKNOWN_DIAGNOSTIC_ATTRIBUTES,
4549 Warn,
4550"detects unknown diagnostic attributes",
4551}45524553#[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! {
4554/// The `malformed_diagnostic_format_literals` lint detects malformed diagnostic format
4555 /// literals.
4556 ///
4557 /// ### Example
4558 ///
4559 /// ```rust
4560 /// #[diagnostic::on_unimplemented(message = "{Self}} does not implement `Trait`")]
4561 /// trait Trait {}
4562 /// ```
4563 ///
4564 /// {{produces}}
4565 ///
4566 /// ### Explanation
4567 ///
4568 /// The `#[diagnostic::on_unimplemented]` attribute accepts string literal values that are
4569 /// similar to `format!`'s string literal. See the [reference] for details on what is permitted
4570 /// in this string literal.
4571 ///
4572 /// [reference]: https://doc.rust-lang.org/nightly/reference/attributes/diagnostics.html#the-diagnostic-tool-attribute-namespace
4573pub MALFORMED_DIAGNOSTIC_FORMAT_LITERALS,
4574 Warn,
4575"detects diagnostic attribute with malformed diagnostic format literals",
4576}4577#[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::Deny,
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! {
4578/// The `ambiguous_glob_imports` lint detects glob imports that should report ambiguity
4579 /// errors, but previously didn't do that due to rustc bugs.
4580 ///
4581 /// ### Example
4582 ///
4583 /// ```rust,compile_fail
4584 /// #![deny(ambiguous_glob_imports)]
4585 /// pub fn foo() -> u32 {
4586 /// use sub::*;
4587 /// C
4588 /// }
4589 ///
4590 /// mod sub {
4591 /// mod mod1 { pub const C: u32 = 1; }
4592 /// mod mod2 { pub const C: u32 = 2; }
4593 ///
4594 /// pub use mod1::*;
4595 /// pub use mod2::*;
4596 /// }
4597 /// ```
4598 ///
4599 /// {{produces}}
4600 ///
4601 /// ### Explanation
4602 ///
4603 /// Previous versions of Rust compile it successfully because it
4604 /// had lost the ambiguity error when resolve `use sub::mod2::*`.
4605 ///
4606 /// This is a [future-incompatible] lint to transition this to a
4607 /// hard error in the future.
4608 ///
4609 /// [future-incompatible]: ../index.md#future-incompatible-lints
4610pub AMBIGUOUS_GLOB_IMPORTS,
4611 Deny,
4612"detects certain glob imports that require reporting an ambiguity error",
4613 @future_incompatible = FutureIncompatibleInfo {
4614 reason: fcw!(FutureReleaseError #114095),
4615 report_in_deps: true,
4616 };
4617}46184619#[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! {
4620/// The `ambiguous_glob_imported_traits` lint reports uses of traits that are
4621 /// imported ambiguously via glob imports. Previously, this was not enforced
4622 /// due to a bug in rustc.
4623 ///
4624 /// ### Example
4625 ///
4626 /// ```rust,compile_fail
4627 /// #![deny(ambiguous_glob_imported_traits)]
4628 /// mod m1 {
4629 /// pub trait Trait {
4630 /// fn method1(&self) {}
4631 /// }
4632 /// impl Trait for u8 {}
4633 /// }
4634 /// mod m2 {
4635 /// pub trait Trait {
4636 /// fn method2(&self) {}
4637 /// }
4638 /// impl Trait for u8 {}
4639 /// }
4640 ///
4641 /// fn main() {
4642 /// use m1::*;
4643 /// use m2::*;
4644 /// 0u8.method1();
4645 /// 0u8.method2();
4646 /// }
4647 /// ```
4648 ///
4649 /// {{produces}}
4650 ///
4651 /// ### Explanation
4652 ///
4653 /// When multiple traits with the same name are brought into scope through glob imports,
4654 /// one trait becomes the "primary" one while the others are shadowed. Methods from the
4655 /// shadowed traits (e.g. `method2`) become inaccessible, while methods from the "primary"
4656 /// trait (e.g. `method1`) still resolve. Ideally, none of the ambiguous traits would be in scope,
4657 /// but we have to allow this for now because of backwards compatibility.
4658 /// This lint reports uses of these "primary" traits that are ambiguous.
4659 ///
4660 /// This is a [future-incompatible] lint to transition this to a
4661 /// hard error in the future.
4662 ///
4663 /// [future-incompatible]: ../index.md#future-incompatible-lints
4664pub AMBIGUOUS_GLOB_IMPORTED_TRAITS,
4665 Warn,
4666"detects uses of ambiguously glob imported traits",
4667 @future_incompatible = FutureIncompatibleInfo {
4668 reason: fcw!(FutureReleaseError #147992),
4669 report_in_deps: false,
4670 };
4671}46724673#[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! {
4674/// The `ambiguous_panic_imports` lint detects ambiguous core and std panic imports, but
4675 /// previously didn't do that due to `#[macro_use]` prelude macro import.
4676 ///
4677 /// ### Example
4678 ///
4679 /// ```rust,compile_fail
4680 /// #![deny(ambiguous_panic_imports)]
4681 /// #![no_std]
4682 ///
4683 /// extern crate std;
4684 /// use std::prelude::v1::*;
4685 ///
4686 /// fn xx() {
4687 /// panic!(); // resolves to core::panic
4688 /// }
4689 /// ```
4690 ///
4691 /// {{produces}}
4692 ///
4693 /// ### Explanation
4694 ///
4695 /// Future versions of Rust will no longer accept the ambiguous resolution.
4696 ///
4697 /// This is a [future-incompatible] lint to transition this to a hard error in the future.
4698 ///
4699 /// [future-incompatible]: ../index.md#future-incompatible-lints
4700pub AMBIGUOUS_PANIC_IMPORTS,
4701 Warn,
4702"detects ambiguous core and std panic imports",
4703 @future_incompatible = FutureIncompatibleInfo {
4704 reason: fcw!(FutureReleaseError #147319),
4705 report_in_deps: false,
4706 };
4707}47084709#[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! {
4710/// The `ambiguous_import_visibilities` lint detects imports that should report ambiguity
4711 /// errors, but previously didn't do that due to rustc bugs.
4712 ///
4713 /// ### Example
4714 ///
4715 /// ```rust,compile_fail
4716 /// #![deny(unknown_lints)]
4717 /// #![deny(ambiguous_import_visibilities)]
4718 /// mod reexport {
4719 /// mod m {
4720 /// pub struct S {}
4721 /// }
4722 ///
4723 /// macro_rules! mac {
4724 /// () => { use m::S; }
4725 /// }
4726 ///
4727 /// pub use m::*;
4728 /// mac!();
4729 ///
4730 /// pub use S as Z; // ambiguous visibility
4731 /// }
4732 ///
4733 /// fn main() {
4734 /// reexport::Z {};
4735 /// }
4736 /// ```
4737 ///
4738 /// {{produces}}
4739 ///
4740 /// ### Explanation
4741 ///
4742 /// Previous versions of Rust compile it successfully because it
4743 /// fetched the glob import's visibility for `pub use S as Z` import, and ignored the private
4744 /// `use m::S` import that appeared later.
4745 ///
4746 /// This is a [future-incompatible] lint to transition this to a
4747 /// hard error in the future.
4748 ///
4749 /// [future-incompatible]: ../index.md#future-incompatible-lints
4750pub AMBIGUOUS_IMPORT_VISIBILITIES,
4751 Warn,
4752"detects certain glob imports that require reporting an ambiguity error",
4753 @future_incompatible = FutureIncompatibleInfo {
4754 reason: fcw!(FutureReleaseError #149145),
4755 };
4756}47574758#[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! {
4759/// The `refining_impl_trait_reachable` lint detects `impl Trait` return
4760 /// types in method signatures that are refined by a publically reachable
4761 /// trait implementation, meaning the implementation adds information about
4762 /// the return type that is not present in the trait.
4763 ///
4764 /// ### Example
4765 ///
4766 /// ```rust,compile_fail
4767 /// #![deny(refining_impl_trait)]
4768 ///
4769 /// use std::fmt::Display;
4770 ///
4771 /// pub trait AsDisplay {
4772 /// fn as_display(&self) -> impl Display;
4773 /// }
4774 ///
4775 /// impl<'s> AsDisplay for &'s str {
4776 /// fn as_display(&self) -> Self {
4777 /// *self
4778 /// }
4779 /// }
4780 ///
4781 /// fn main() {
4782 /// // users can observe that the return type of
4783 /// // `<&str as AsDisplay>::as_display()` is `&str`.
4784 /// let _x: &str = "".as_display();
4785 /// }
4786 /// ```
4787 ///
4788 /// {{produces}}
4789 ///
4790 /// ### Explanation
4791 ///
4792 /// Callers of methods for types where the implementation is known are
4793 /// able to observe the types written in the impl signature. This may be
4794 /// intended behavior, but may also lead to implementation details being
4795 /// revealed unintentionally. In particular, it may pose a semver hazard
4796 /// for authors of libraries who do not wish to make stronger guarantees
4797 /// about the types than what is written in the trait signature.
4798 ///
4799 /// `refining_impl_trait` is a lint group composed of two lints:
4800 ///
4801 /// * `refining_impl_trait_reachable`, for refinements that are publically
4802 /// reachable outside a crate, and
4803 /// * `refining_impl_trait_internal`, for refinements that are only visible
4804 /// within a crate.
4805 ///
4806 /// We are seeking feedback on each of these lints; see issue
4807 /// [#121718](https://github.com/rust-lang/rust/issues/121718) for more
4808 /// information.
4809pub REFINING_IMPL_TRAIT_REACHABLE,
4810 Warn,
4811"impl trait in impl method signature does not match trait method signature",
4812}48134814#[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! {
4815/// The `refining_impl_trait_internal` lint detects `impl Trait` return
4816 /// types in method signatures that are refined by a trait implementation,
4817 /// meaning the implementation adds information about the return type that
4818 /// is not present in the trait.
4819 ///
4820 /// ### Example
4821 ///
4822 /// ```rust,compile_fail
4823 /// #![deny(refining_impl_trait)]
4824 ///
4825 /// use std::fmt::Display;
4826 ///
4827 /// trait AsDisplay {
4828 /// fn as_display(&self) -> impl Display;
4829 /// }
4830 ///
4831 /// impl<'s> AsDisplay for &'s str {
4832 /// fn as_display(&self) -> Self {
4833 /// *self
4834 /// }
4835 /// }
4836 ///
4837 /// fn main() {
4838 /// // users can observe that the return type of
4839 /// // `<&str as AsDisplay>::as_display()` is `&str`.
4840 /// let _x: &str = "".as_display();
4841 /// }
4842 /// ```
4843 ///
4844 /// {{produces}}
4845 ///
4846 /// ### Explanation
4847 ///
4848 /// Callers of methods for types where the implementation is known are
4849 /// able to observe the types written in the impl signature. This may be
4850 /// intended behavior, but may also lead to implementation details being
4851 /// revealed unintentionally. In particular, it may pose a semver hazard
4852 /// for authors of libraries who do not wish to make stronger guarantees
4853 /// about the types than what is written in the trait signature.
4854 ///
4855 /// `refining_impl_trait` is a lint group composed of two lints:
4856 ///
4857 /// * `refining_impl_trait_reachable`, for refinements that are publically
4858 /// reachable outside a crate, and
4859 /// * `refining_impl_trait_internal`, for refinements that are only visible
4860 /// within a crate.
4861 ///
4862 /// We are seeking feedback on each of these lints; see issue
4863 /// [#121718](https://github.com/rust-lang/rust/issues/121718) for more
4864 /// information.
4865pub REFINING_IMPL_TRAIT_INTERNAL,
4866 Warn,
4867"impl trait in impl method signature does not match trait method signature",
4868}48694870#[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! {
4871/// The `elided_lifetimes_in_associated_constant` lint detects elided lifetimes
4872 /// in associated constants when there are other lifetimes in scope. This was
4873 /// accidentally supported, and this lint was later relaxed to allow eliding
4874 /// lifetimes to `'static` when there are no lifetimes in scope.
4875 ///
4876 /// ### Example
4877 ///
4878 /// ```rust,compile_fail
4879 /// #![deny(elided_lifetimes_in_associated_constant)]
4880 ///
4881 /// struct Foo<'a>(&'a ());
4882 ///
4883 /// impl<'a> Foo<'a> {
4884 /// const STR: &str = "hello, world";
4885 /// }
4886 /// ```
4887 ///
4888 /// {{produces}}
4889 ///
4890 /// ### Explanation
4891 ///
4892 /// Previous version of Rust
4893 ///
4894 /// Implicit static-in-const behavior was decided [against] for associated
4895 /// constants because of ambiguity. This, however, regressed and the compiler
4896 /// erroneously treats elided lifetimes in associated constants as lifetime
4897 /// parameters on the impl.
4898 ///
4899 /// This is a [future-incompatible] lint to transition this to a
4900 /// hard error in the future.
4901 ///
4902 /// [against]: https://github.com/rust-lang/rust/issues/38831
4903 /// [future-incompatible]: ../index.md#future-incompatible-lints
4904pub ELIDED_LIFETIMES_IN_ASSOCIATED_CONSTANT,
4905 Deny,
4906"elided lifetimes cannot be used in associated constants in impls",
4907 @future_incompatible = FutureIncompatibleInfo {
4908 reason: fcw!(FutureReleaseError #115010),
4909 };
4910}49114912#[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! {
4913/// The `private_macro_use` lint detects private macros that are imported
4914 /// with `#[macro_use]`.
4915 ///
4916 /// ### Example
4917 ///
4918 /// ```rust,ignore (needs extern crate)
4919 /// // extern_macro.rs
4920 /// macro_rules! foo_ { () => {}; }
4921 /// use foo_ as foo;
4922 ///
4923 /// // code.rs
4924 ///
4925 /// #![deny(private_macro_use)]
4926 ///
4927 /// #[macro_use]
4928 /// extern crate extern_macro;
4929 ///
4930 /// fn main() {
4931 /// foo!();
4932 /// }
4933 /// ```
4934 ///
4935 /// This will produce:
4936 ///
4937 /// ```text
4938 /// error: cannot find macro `foo` in this scope
4939 /// ```
4940 ///
4941 /// ### Explanation
4942 ///
4943 /// This lint arises from overlooking visibility checks for macros
4944 /// in an external crate.
4945 ///
4946 /// This is a [future-incompatible] lint to transition this to a
4947 /// hard error in the future.
4948 ///
4949 /// [future-incompatible]: ../index.md#future-incompatible-lints
4950pub PRIVATE_MACRO_USE,
4951 Deny,
4952"detects certain macro bindings that should not be re-exported",
4953 @future_incompatible = FutureIncompatibleInfo {
4954 reason: fcw!(FutureReleaseError #120192),
4955 report_in_deps: true,
4956 };
4957}49584959#[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! {
4960/// The `uncovered_param_in_projection` lint detects a violation of one of Rust's orphan rules for
4961 /// foreign trait implementations that concerns the use of type parameters inside trait associated
4962 /// type paths ("projections") whose output may not be a local type that is mistakenly considered
4963 /// to "cover" said parameters which is **unsound** and which may be rejected by a future version
4964 /// of the compiler.
4965 ///
4966 /// Originally reported in [#99554].
4967 ///
4968 /// [#99554]: https://github.com/rust-lang/rust/issues/99554
4969 ///
4970 /// ### Example
4971 ///
4972 /// ```rust,ignore (dependent)
4973 /// // dependency.rs
4974 /// #![crate_type = "lib"]
4975 ///
4976 /// pub trait Trait<T, U> {}
4977 /// ```
4978 ///
4979 /// ```edition2021,ignore (needs dependency)
4980 /// // dependent.rs
4981 /// trait Identity {
4982 /// type Output;
4983 /// }
4984 ///
4985 /// impl<T> Identity for T {
4986 /// type Output = T;
4987 /// }
4988 ///
4989 /// struct Local;
4990 ///
4991 /// impl<T> dependency::Trait<Local, T> for <T as Identity>::Output {}
4992 ///
4993 /// fn main() {}
4994 /// ```
4995 ///
4996 /// This will produce:
4997 ///
4998 /// ```text
4999 /// warning[E0210]: type parameter `T` must be covered by another type when it appears before the first local type (`Local`)
5000 /// --> dependent.rs:11:6
5001 /// |
5002 /// 11 | impl<T> dependency::Trait<Local, T> for <T as Identity>::Output {}
5003 /// | ^ type parameter `T` must be covered by another type when it appears before the first local type (`Local`)
5004 /// |
5005 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
5006 /// = note: for more information, see issue #124559 <https://github.com/rust-lang/rust/issues/124559>
5007 /// = 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
5008 /// = 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
5009 /// = note: `#[warn(uncovered_param_in_projection)]` on by default
5010 /// ```
5011 ///
5012 /// ### Explanation
5013 ///
5014 /// FIXME(fmease): Write explainer.
5015pub UNCOVERED_PARAM_IN_PROJECTION,
5016 Warn,
5017"impl contains type parameters that are not covered",
5018 @future_incompatible = FutureIncompatibleInfo {
5019 reason: fcw!(FutureReleaseError #124559),
5020 };
5021}50225023#[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! {
5024/// The `deprecated_safe_2024` lint detects unsafe functions being used as
5025 /// safe functions.
5026 ///
5027 /// ### Example
5028 ///
5029 /// ```rust,edition2021,compile_fail
5030 /// #![deny(deprecated_safe)]
5031 /// // edition 2021
5032 /// use std::env;
5033 /// fn enable_backtrace() {
5034 /// env::set_var("RUST_BACKTRACE", "1");
5035 /// }
5036 /// ```
5037 ///
5038 /// {{produces}}
5039 ///
5040 /// ### Explanation
5041 ///
5042 /// Rust [editions] allow the language to evolve without breaking backward
5043 /// compatibility. This lint catches code that uses `unsafe` functions that
5044 /// were declared as safe (non-`unsafe`) in editions prior to Rust 2024. If
5045 /// you switch the compiler to Rust 2024 without updating the code, then it
5046 /// will fail to compile if you are using a function previously marked as
5047 /// safe.
5048 ///
5049 /// You can audit the code to see if it suffices the preconditions of the
5050 /// `unsafe` code, and if it does, you can wrap it in an `unsafe` block. If
5051 /// you can't fulfill the preconditions, you probably need to switch to a
5052 /// different way of doing what you want to achieve.
5053 ///
5054 /// This lint can automatically wrap the calls in `unsafe` blocks, but this
5055 /// obviously cannot verify that the preconditions of the `unsafe`
5056 /// functions are fulfilled, so that is still up to the user.
5057 ///
5058 /// The lint is currently "allow" by default, but that might change in the
5059 /// future.
5060 ///
5061 /// [editions]: https://doc.rust-lang.org/edition-guide/
5062pub DEPRECATED_SAFE_2024,
5063 Allow,
5064"detects unsafe functions being used as safe functions",
5065 @future_incompatible = FutureIncompatibleInfo {
5066 reason: fcw!(EditionError 2024 "newly-unsafe-functions"),
5067 };
5068}50695070#[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! {
5071/// The `missing_unsafe_on_extern` lint detects missing unsafe keyword on extern declarations.
5072 ///
5073 /// ### Example
5074 ///
5075 /// ```rust,edition2021
5076 /// #![warn(missing_unsafe_on_extern)]
5077 /// #![allow(dead_code)]
5078 ///
5079 /// extern "C" {
5080 /// fn foo(_: i32);
5081 /// }
5082 ///
5083 /// fn main() {}
5084 /// ```
5085 ///
5086 /// {{produces}}
5087 ///
5088 /// ### Explanation
5089 ///
5090 /// Declaring extern items, even without ever using them, can cause Undefined Behavior. We
5091 /// should consider all sources of Undefined Behavior to be unsafe.
5092 ///
5093 /// This is a [future-incompatible] lint to transition this to a
5094 /// hard error in the future.
5095 ///
5096 /// [future-incompatible]: ../index.md#future-incompatible-lints
5097pub MISSING_UNSAFE_ON_EXTERN,
5098 Allow,
5099"detects missing unsafe keyword on extern declarations",
5100 @future_incompatible = FutureIncompatibleInfo {
5101 reason: fcw!(EditionError 2024 "unsafe-extern"),
5102 };
5103}51045105#[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! {
5106/// The `unsafe_attr_outside_unsafe` lint detects a missing unsafe keyword
5107 /// on attributes considered unsafe.
5108 ///
5109 /// ### Example
5110 ///
5111 /// ```rust,edition2021
5112 /// #![warn(unsafe_attr_outside_unsafe)]
5113 ///
5114 /// #[no_mangle]
5115 /// extern "C" fn foo() {}
5116 ///
5117 /// fn main() {}
5118 /// ```
5119 ///
5120 /// {{produces}}
5121 ///
5122 /// ### Explanation
5123 ///
5124 /// Some attributes (e.g. `no_mangle`, `export_name`, `link_section` -- see
5125 /// [issue #82499] for a more complete list) are considered "unsafe" attributes.
5126 /// An unsafe attribute must only be used inside unsafe(...).
5127 ///
5128 /// This lint can automatically wrap the attributes in `unsafe(...)` , but this
5129 /// obviously cannot verify that the preconditions of the `unsafe`
5130 /// attributes are fulfilled, so that is still up to the user.
5131 ///
5132 /// The lint is currently "allow" by default, but that might change in the
5133 /// future.
5134 ///
5135 /// [editions]: https://doc.rust-lang.org/edition-guide/
5136 /// [issue #82499]: https://github.com/rust-lang/rust/issues/82499
5137pub UNSAFE_ATTR_OUTSIDE_UNSAFE,
5138 Allow,
5139"detects unsafe attributes outside of unsafe",
5140 @future_incompatible = FutureIncompatibleInfo {
5141 reason: fcw!(EditionError 2024 "unsafe-attributes"),
5142 };
5143}51445145#[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! {
5146/// The `out_of_scope_macro_calls` lint detects `macro_rules` called when they are not in scope,
5147 /// above their definition, which may happen in key-value attributes.
5148 ///
5149 /// ### Example
5150 ///
5151 /// ```rust,compile_fail
5152 /// #![doc = in_root!()]
5153 ///
5154 /// macro_rules! in_root { () => { "" } }
5155 ///
5156 /// fn main() {}
5157 /// ```
5158 ///
5159 /// {{produces}}
5160 ///
5161 /// ### Explanation
5162 ///
5163 /// The scope in which a `macro_rules` item is visible starts at that item and continues
5164 /// below it. This is more similar to `let` than to other items, which are in scope both above
5165 /// and below their definition.
5166 /// Due to a bug `macro_rules` were accidentally in scope inside some key-value attributes
5167 /// above their definition. The lint catches such cases.
5168 /// To address the issue turn the `macro_rules` into a regularly scoped item by importing it
5169 /// with `use`.
5170 ///
5171 /// This is a [future-incompatible] lint to transition this to a
5172 /// hard error in the future.
5173 ///
5174 /// [future-incompatible]: ../index.md#future-incompatible-lints
5175pub OUT_OF_SCOPE_MACRO_CALLS,
5176 Deny,
5177"detects out of scope calls to `macro_rules` in key-value attributes",
5178 @future_incompatible = FutureIncompatibleInfo {
5179 reason: fcw!(FutureReleaseError #124535),
5180 report_in_deps: true,
5181 };
5182}51835184#[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! {
5185/// The `resolving_to_items_shadowing_supertrait_items` lint detects when the
5186 /// usage of an item that is provided by both a subtrait and supertrait
5187 /// is shadowed, preferring the subtrait.
5188 ///
5189 /// ### Example
5190 ///
5191 /// ```rust,compile_fail
5192 /// #![feature(supertrait_item_shadowing)]
5193 /// #![deny(resolving_to_items_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 /// struct MyType;
5206 /// MyType.hello();
5207 /// ```
5208 ///
5209 /// {{produces}}
5210 ///
5211 /// ### Explanation
5212 ///
5213 /// RFC 3624 specified a heuristic in which a supertrait item would be
5214 /// shadowed by a subtrait item when ambiguity occurs during item
5215 /// selection. In order to mitigate side-effects of this happening
5216 /// silently, this lint detects these cases when users want to deny them
5217 /// or fix the call sites.
5218pub RESOLVING_TO_ITEMS_SHADOWING_SUPERTRAIT_ITEMS,
5219// FIXME(supertrait_item_shadowing): It is not decided if this should
5220 // warn by default at the call site.
5221Allow,
5222"detects when a supertrait item is shadowed by a subtrait item",
5223 @feature_gate = supertrait_item_shadowing;
5224}52255226#[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! {
5227/// The `shadowing_supertrait_items` lint detects when the
5228 /// definition of an item that is provided by both a subtrait and
5229 /// supertrait is shadowed, preferring the subtrait.
5230 ///
5231 /// ### Example
5232 ///
5233 /// ```rust,compile_fail
5234 /// #![feature(supertrait_item_shadowing)]
5235 /// #![deny(shadowing_supertrait_items)]
5236 ///
5237 /// trait Upstream {
5238 /// fn hello(&self) {}
5239 /// }
5240 /// impl<T> Upstream for T {}
5241 ///
5242 /// trait Downstream: Upstream {
5243 /// fn hello(&self) {}
5244 /// }
5245 /// impl<T> Downstream for T {}
5246 /// ```
5247 ///
5248 /// {{produces}}
5249 ///
5250 /// ### Explanation
5251 ///
5252 /// RFC 3624 specified a heuristic in which a supertrait item would be
5253 /// shadowed by a subtrait item when ambiguity occurs during item
5254 /// selection. In order to mitigate side-effects of this happening
5255 /// silently, this lint detects these cases when users want to deny them
5256 /// or fix their trait definitions.
5257pub SHADOWING_SUPERTRAIT_ITEMS,
5258// FIXME(supertrait_item_shadowing): It is not decided if this should
5259 // warn by default at the usage site.
5260Allow,
5261"detects when a supertrait item is shadowed by a subtrait item",
5262 @feature_gate = supertrait_item_shadowing;
5263}52645265#[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! {
5266/// The `tail_expr_drop_order` lint looks for those values generated at the tail expression location,
5267 /// that runs a custom `Drop` destructor.
5268 /// Some of them may be dropped earlier in Edition 2024 that they used to in Edition 2021 and prior.
5269 /// This lint detects those cases and provides you information on those values and their custom destructor implementations.
5270 /// Your discretion on this information is required.
5271 ///
5272 /// ### Example
5273 /// ```rust,edition2021
5274 /// #![warn(tail_expr_drop_order)]
5275 /// struct Droppy(i32);
5276 /// impl Droppy {
5277 /// fn get(&self) -> i32 {
5278 /// self.0
5279 /// }
5280 /// }
5281 /// impl Drop for Droppy {
5282 /// fn drop(&mut self) {
5283 /// // This is a custom destructor and it induces side-effects that is observable
5284 /// // especially when the drop order at a tail expression changes.
5285 /// println!("loud drop {}", self.0);
5286 /// }
5287 /// }
5288 /// fn edition_2021() -> i32 {
5289 /// let another_droppy = Droppy(0);
5290 /// Droppy(1).get()
5291 /// }
5292 /// fn main() {
5293 /// edition_2021();
5294 /// }
5295 /// ```
5296 ///
5297 /// {{produces}}
5298 ///
5299 /// ### Explanation
5300 ///
5301 /// In tail expression of blocks or function bodies,
5302 /// values of type with significant `Drop` implementation has an ill-specified drop order
5303 /// before Edition 2024 so that they are dropped only after dropping local variables.
5304 /// Edition 2024 introduces a new rule with drop orders for them,
5305 /// so that they are dropped first before dropping local variables.
5306 ///
5307 /// A significant `Drop::drop` destructor here refers to an explicit, arbitrary
5308 /// implementation of the `Drop` trait on the type, with exceptions including `Vec`,
5309 /// `Box`, `Rc`, `BTreeMap` and `HashMap` that are marked by the compiler otherwise
5310 /// so long that the generic types have no significant destructor recursively.
5311 /// In other words, a type has a significant drop destructor when it has a `Drop` implementation
5312 /// or its destructor invokes a significant destructor on a type.
5313 /// Since we cannot completely reason about the change by just inspecting the existence of
5314 /// a significant destructor, this lint remains only a suggestion and is set to `allow` by default.
5315 ///
5316 /// This lint only points out the issue with `Droppy`, which will be dropped before `another_droppy`
5317 /// does in Edition 2024.
5318 /// No fix will be proposed by this lint.
5319 /// However, the most probable fix is to hoist `Droppy` into its own local variable binding.
5320 /// ```rust
5321 /// struct Droppy(i32);
5322 /// impl Droppy {
5323 /// fn get(&self) -> i32 {
5324 /// self.0
5325 /// }
5326 /// }
5327 /// fn edition_2024() -> i32 {
5328 /// let value = Droppy(0);
5329 /// let another_droppy = Droppy(1);
5330 /// value.get()
5331 /// }
5332 /// ```
5333pub TAIL_EXPR_DROP_ORDER,
5334 Allow,
5335"Detect and warn on significant change in drop order in tail expression location",
5336 @future_incompatible = FutureIncompatibleInfo {
5337 reason: fcw!(EditionSemanticsChange 2024 "temporary-tail-expr-scope"),
5338 };
5339}53405341#[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! {
5342/// The `rust_2024_guarded_string_incompatible_syntax` lint detects `#` tokens
5343 /// that will be parsed as part of a guarded string literal in Rust 2024.
5344 ///
5345 /// ### Example
5346 ///
5347 /// ```rust,edition2021,compile_fail
5348 /// #![deny(rust_2024_guarded_string_incompatible_syntax)]
5349 ///
5350 /// macro_rules! m {
5351 /// (# $x:expr #) => ();
5352 /// (# $x:expr) => ();
5353 /// }
5354 ///
5355 /// m!(#"hey"#);
5356 /// m!(#"hello");
5357 /// ```
5358 ///
5359 /// {{produces}}
5360 ///
5361 /// ### Explanation
5362 ///
5363 /// Prior to Rust 2024, `#"hey"#` is three tokens: the first `#`
5364 /// followed by the string literal `"hey"` then the final `#`.
5365 /// In Rust 2024, the whole sequence is considered a single token.
5366 ///
5367 /// This lint suggests to add whitespace between the leading `#`
5368 /// and the string to keep them separated in Rust 2024.
5369// Allow this lint -- rustdoc doesn't yet support threading edition into this lint's parser.
5370#[allow(rustdoc::invalid_rust_codeblocks)]
5371pub RUST_2024_GUARDED_STRING_INCOMPATIBLE_SYNTAX,
5372 Allow,
5373"will be parsed as a guarded string in Rust 2024",
5374 @future_incompatible = FutureIncompatibleInfo {
5375 reason: fcw!(EditionError 2024 "reserved-syntax"),
5376 };
5377 crate_level_only
5378}53795380#[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! {
5381/// The `aarch64_softfloat_neon` lint detects usage of `#[target_feature(enable = "neon")]` on
5382 /// softfloat aarch64 targets. Enabling this target feature causes LLVM to alter the ABI of
5383 /// function calls, making this attribute unsound to use.
5384 ///
5385 /// ### Example
5386 ///
5387 /// ```rust,ignore (needs aarch64-unknown-none-softfloat)
5388 /// #[target_feature(enable = "neon")]
5389 /// fn with_neon() {}
5390 /// ```
5391 ///
5392 /// This will produce:
5393 ///
5394 /// ```text
5395 /// error: enabling the `neon` target feature on the current target is unsound due to ABI issues
5396 /// --> $DIR/abi-incompatible-target-feature-attribute-fcw.rs:11:18
5397 /// |
5398 /// | #[target_feature(enable = "neon")]
5399 /// | ^^^^^^^^^^^^^^^
5400 /// |
5401 /// = warning: this was previously accepted by the compiler but is being phased out; it will become a hard error in a future release!
5402 /// = note: for more information, see issue #134375 <https://github.com/rust-lang/rust/issues/134375>
5403 /// ```
5404 ///
5405 /// ### Explanation
5406 ///
5407 /// If a function like `with_neon` above ends up containing calls to LLVM builtins, those will
5408 /// not use the correct ABI. This is caused by a lack of support in LLVM for mixing code with
5409 /// and without the `neon` target feature. The target feature should never have been stabilized
5410 /// on this target due to this issue, but the problem was not known at the time of
5411 /// stabilization.
5412pub AARCH64_SOFTFLOAT_NEON,
5413 Warn,
5414"detects code that could be affected by ABI issues on aarch64 softfloat targets",
5415 @future_incompatible = FutureIncompatibleInfo {
5416 reason: fcw!(FutureReleaseError #134375),
5417 report_in_deps: true,
5418 };
5419}54205421#[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! {
5422/// The `tail_call_track_caller` lint detects usage of `become` attempting to tail call
5423 /// a function marked with `#[track_caller]`.
5424 ///
5425 /// ### Example
5426 ///
5427 /// ```rust
5428 /// #![feature(explicit_tail_calls)]
5429 /// #![expect(incomplete_features)]
5430 ///
5431 /// #[track_caller]
5432 /// fn f() {}
5433 ///
5434 /// fn g() {
5435 /// become f();
5436 /// }
5437 ///
5438 /// g();
5439 /// ```
5440 ///
5441 /// {{produces}}
5442 ///
5443 /// ### Explanation
5444 ///
5445 /// Due to implementation details of tail calls and `#[track_caller]` attribute, calls to
5446 /// functions marked with `#[track_caller]` cannot become tail calls. As such using `become`
5447 /// is no different than a normal call (except for changes in drop order).
5448pub TAIL_CALL_TRACK_CALLER,
5449 Warn,
5450"detects tail calls of functions marked with `#[track_caller]`",
5451 @feature_gate = explicit_tail_calls;
5452}5453#[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! {
5454/// The `inline_always_mismatching_target_features` lint will trigger when a
5455 /// function with the `#[inline(always)]` and `#[target_feature(enable = "...")]`
5456 /// attributes is called and cannot be inlined due to missing target features in the caller.
5457 ///
5458 /// ### Example
5459 ///
5460 /// ```rust,ignore (fails on x86_64)
5461 /// #[inline(always)]
5462 /// #[target_feature(enable = "fp16")]
5463 /// unsafe fn callee() {
5464 /// // operations using fp16 types
5465 /// }
5466 ///
5467 /// // Caller does not enable the required target feature
5468 /// fn caller() {
5469 /// unsafe { callee(); }
5470 /// }
5471 ///
5472 /// fn main() {
5473 /// caller();
5474 /// }
5475 /// ```
5476 ///
5477 /// This will produce:
5478 ///
5479 /// ```text
5480 /// warning: call to `#[inline(always)]`-annotated `callee` requires the same target features. Function will not have `alwaysinline` attribute applied
5481 /// --> $DIR/builtin.rs:5192:14
5482 /// |
5483 /// 10 | unsafe { callee(); }
5484 /// | ^^^^^^^^
5485 /// |
5486 /// note: `fp16` target feature enabled in `callee` here but missing from `caller`
5487 /// --> $DIR/builtin.rs:5185:1
5488 /// |
5489 /// 3 | #[target_feature(enable = "fp16")]
5490 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5491 /// 4 | unsafe fn callee() {
5492 /// | ------------------
5493 /// = note: `#[warn(inline_always_mismatching_target_features)]` on by default
5494 /// warning: 1 warning emitted
5495 /// ```
5496 ///
5497 /// ### Explanation
5498 ///
5499 /// Inlining a function with a target feature attribute into a caller that
5500 /// lacks the corresponding target feature can lead to unsound behavior.
5501 /// LLVM may select the wrong instructions or registers, or reorder
5502 /// operations, potentially resulting in runtime errors.
5503pub INLINE_ALWAYS_MISMATCHING_TARGET_FEATURES,
5504 Warn,
5505r#"detects when a function annotated with `#[inline(always)]` and `#[target_feature(enable = "..")]` is inlined into a caller without the required target feature"#,
5506}55075508#[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! {
5509/// The `repr_c_enums_larger_than_int` lint detects `repr(C)` enums with discriminant
5510 /// values that do not fit into a C `int` or `unsigned int`.
5511 ///
5512 /// ### Example
5513 ///
5514 /// ```rust,ignore (only errors on 64bit)
5515 /// #[repr(C)]
5516 /// enum E {
5517 /// V = 9223372036854775807, // i64::MAX
5518 /// }
5519 /// ```
5520 ///
5521 /// This will produce:
5522 ///
5523 /// ```text
5524 /// error: `repr(C)` enum discriminant does not fit into C `int` nor into C `unsigned int`
5525 /// --> $DIR/repr-c-big-discriminant1.rs:16:5
5526 /// |
5527 /// LL | A = 9223372036854775807, // i64::MAX
5528 /// | ^
5529 /// |
5530 /// = note: `repr(C)` enums with big discriminants are non-portable, and their size in Rust might not match their size in C
5531 /// = help: use `repr($int_ty)` instead to explicitly set the size of this enum
5532 /// ```
5533 ///
5534 /// ### Explanation
5535 ///
5536 /// In C, enums with discriminants that do not all fit into an `int` or all fit into an
5537 /// `unsigned int` are a portability hazard: such enums are only permitted since C23, and not
5538 /// supported e.g. by MSVC.
5539 ///
5540 /// Furthermore, Rust interprets the discriminant values of `repr(C)` enums as expressions of
5541 /// type `isize`. This makes it impossible to implement the C23 behavior of enums where the enum
5542 /// discriminants have no predefined type and instead the enum uses a type large enough to hold
5543 /// all discriminants.
5544 ///
5545 /// Therefore, `repr(C)` enums in Rust require that either all discriminants to fit into a C
5546 /// `int` or they all fit into an `unsigned int`.
5547pub REPR_C_ENUMS_LARGER_THAN_INT,
5548 Warn,
5549"repr(C) enums with discriminant values that do not fit into a C int",
5550 @future_incompatible = FutureIncompatibleInfo {
5551 reason: fcw!(FutureReleaseError #124403),
5552 report_in_deps: false,
5553 };
5554}55555556#[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 = "```rust,compile_fail"]
#[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 = "```"]
#[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::Deny,
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: true,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5557/// The `varargs_without_pattern` lint detects when `...` is used as an argument to a
5558 /// non-foreign function without any pattern being specified.
5559 ///
5560 /// ### Example
5561 ///
5562#[cfg_attr(bootstrap, doc = "```rust")]
5563 #[cfg_attr(not(bootstrap), doc = "```rust,compile_fail")]
5564/// // Using `...` in non-foreign function definitions is unstable, however stability is
5565 /// // currently only checked after attributes are expanded, so using `#[cfg(false)]` here will
5566 /// // allow this to compile on stable Rust.
5567 /// #[cfg(false)]
5568 /// fn foo(...) {
5569 ///
5570 /// }
5571#[doc = "```"]
5572///
5573 /// {{produces}}
5574 ///
5575 /// ### Explanation
5576 ///
5577 /// Patterns are currently required for all non-`...` arguments in function definitions (with
5578 /// some exceptions in the 2015 edition). Requiring `...` arguments to have patterns in
5579 /// non-foreign function definitions makes the language more consistent, and removes a source of
5580 /// confusion for the unstable C variadic feature. `...` arguments without a pattern are already
5581 /// stable and widely used in foreign function definitions; this lint only affects non-foreign
5582 /// function definitions.
5583 ///
5584 /// Using `...` (C varargs) in a non-foreign function definition is currently unstable. However,
5585 /// stability checking for the `...` syntax in non-foreign function definitions is currently
5586 /// implemented after attributes have been expanded, meaning that if the attribute removes the
5587 /// use of the unstable syntax (e.g. `#[cfg(false)]`, or a procedural macro), the code will
5588 /// compile on stable Rust; this is the only situation where this lint affects code that
5589 /// compiles on stable Rust.
5590 ///
5591 /// This is a [future-incompatible] lint to transition this to a hard error in the future.
5592 ///
5593 /// [future-incompatible]: ../index.md#future-incompatible-lints
5594pub VARARGS_WITHOUT_PATTERN,
5595 Deny,
5596"detects usage of `...` arguments without a pattern in non-foreign items",
5597 @future_incompatible = FutureIncompatibleInfo {
5598 reason: fcw!(FutureReleaseError #145544),
5599 report_in_deps: true,
5600 };
5601}56025603#[doc =
r" The `deprecated_llvm_intrinsic` lint detects usage of deprecated LLVM intrinsics."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (requires x86)"]
#[doc = r#" #![cfg(any(target_arch = "x86", target_arch = "x86_64"))]"#]
#[doc = r" #![feature(link_llvm_intrinsics, abi_unadjusted)]"]
#[doc = r" #![deny(deprecated_llvm_intrinsic)]"]
#[doc = r""]
#[doc = r#" unsafe extern "unadjusted" {"#]
#[doc = r#" #[link_name = "llvm.x86.addcarryx.u32"]"#]
#[doc = r" fn foo(a: u8, b: u32, c: u32, d: &mut u32) -> u8;"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" #[inline(never)]"]
#[doc = r#" #[target_feature(enable = "adx")]"#]
#[doc = r" pub fn bar(a: u8, b: u32, c: u32, d: &mut u32) -> u8 {"]
#[doc = r" unsafe { foo(a, b, c, d) }"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc = r" error: Using deprecated intrinsic `llvm.x86.addcarryx.u32`"]
#[doc = r" --> example.rs:7:5"]
#[doc = r" |"]
#[doc = r" 7 | fn foo(a: u8, b: u32, c: u32, d: &mut u32) -> u8;"]
#[doc = r" | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^"]
#[doc = r" |"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" LLVM periodically updates its list of intrinsics. Deprecated intrinsics are unlikely"]
#[doc =
r" to be removed, but they may optimize less well than their new versions, so it's"]
#[doc =
r" best to use the new version. Also, some deprecated intrinsics might have buggy"]
#[doc = r" behavior"]
pub static DEPRECATED_LLVM_INTRINSIC: &crate::Lint =
&crate::Lint {
name: "DEPRECATED_LLVM_INTRINSIC",
default_level: crate::Allow,
desc: "detects uses of deprecated LLVM intrinsics",
is_externally_loaded: false,
feature_gate: Some(rustc_span::sym::link_llvm_intrinsics),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5604/// The `deprecated_llvm_intrinsic` lint detects usage of deprecated LLVM intrinsics.
5605 ///
5606 /// ### Example
5607 ///
5608 /// ```rust,ignore (requires x86)
5609 /// #![cfg(any(target_arch = "x86", target_arch = "x86_64"))]
5610 /// #![feature(link_llvm_intrinsics, abi_unadjusted)]
5611 /// #![deny(deprecated_llvm_intrinsic)]
5612 ///
5613 /// unsafe extern "unadjusted" {
5614 /// #[link_name = "llvm.x86.addcarryx.u32"]
5615 /// fn foo(a: u8, b: u32, c: u32, d: &mut u32) -> u8;
5616 /// }
5617 ///
5618 /// #[inline(never)]
5619 /// #[target_feature(enable = "adx")]
5620 /// pub fn bar(a: u8, b: u32, c: u32, d: &mut u32) -> u8 {
5621 /// unsafe { foo(a, b, c, d) }
5622 /// }
5623 /// ```
5624 ///
5625 /// This will produce:
5626 ///
5627 /// ```text
5628 /// error: Using deprecated intrinsic `llvm.x86.addcarryx.u32`
5629 /// --> example.rs:7:5
5630 /// |
5631 /// 7 | fn foo(a: u8, b: u32, c: u32, d: &mut u32) -> u8;
5632 /// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5633 /// |
5634 /// ```
5635 ///
5636 /// ### Explanation
5637 ///
5638 /// LLVM periodically updates its list of intrinsics. Deprecated intrinsics are unlikely
5639 /// to be removed, but they may optimize less well than their new versions, so it's
5640 /// best to use the new version. Also, some deprecated intrinsics might have buggy
5641 /// behavior
5642pub DEPRECATED_LLVM_INTRINSIC,
5643 Allow,
5644"detects uses of deprecated LLVM intrinsics",
5645 @feature_gate = link_llvm_intrinsics;
5646}56475648#[doc =
r" The `float_literal_f32_fallback` lint detects situations where the type of an unsuffixed"]
#[doc =
r" float literal falls back to `f32` instead of `f64` to avoid a compilation error. This occurs"]
#[doc =
r" when there is a trait bound `f32: From<T>` (or equivalent, such as `T: Into<f32>`) and the"]
#[doc = r" literal is inferred to have the same type as `T`."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" fn foo(x: impl Into<f32>) -> f32 {"]
#[doc = r" x.into()"]
#[doc = r" }"]
#[doc = r""]
#[doc = r" fn main() {"]
#[doc = r" dbg!(foo(2.5));"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" Rust allows traits that are only implemented for a single floating point type to guide type"]
#[doc =
r" inference for floating point literals. This used to apply in the case of `f32: From<T>`"]
#[doc =
r" (where `T` was inferred to be the same type as a floating point literal), as the only"]
#[doc =
r" floating point type impl was `f32: From<f32>`. However, as Rust is in the process of adding"]
#[doc =
r" support for `f16`, there are now two implementations for floating point types:"]
#[doc =
r" `f32: From<f16>` and `f32: From<f32>`. This means that the trait bound `f32: From<T>` can no"]
#[doc =
r" longer guide inference for the type of the floating point literal. The default fallback for"]
#[doc =
r" unsuffixed floating point literals is `f64`. As `f32` does not implement `From<f64>`,"]
#[doc =
r" falling back to `f64` would cause a compilation error; therefore, the float type fallback"]
#[doc =
r" has been tempoarily adjusted to fallback to `f32` in this scenario."]
#[doc = r""]
#[doc =
r" The lint will automatically provide a machine-applicable suggestion to add a `_f32` suffix"]
#[doc = r" to the literal, which will fix the problem."]
#[doc = r""]
#[doc =
r" This is a [future-incompatible] lint to transition this to a hard error in the future. See"]
#[doc = r" [issue #154024] for more details."]
#[doc = r""]
#[doc = r" [issue #154024]: https://github.com/rust-lang/rust/issues/154024"]
#[doc = r" [future-incompatible]: ../index.md#future-incompatible-lints"]
pub static FLOAT_LITERAL_F32_FALLBACK: &crate::Lint =
&crate::Lint {
name: "FLOAT_LITERAL_F32_FALLBACK",
default_level: crate::Warn,
desc: "detects unsuffixed floating point literals whose type fallback to `f32`",
is_externally_loaded: false,
future_incompatible: Some(crate::FutureIncompatibleInfo {
reason: crate::FutureIncompatibilityReason::FutureReleaseError(crate::ReleaseFcw {
issue_number: 154024,
}),
report_in_deps: false,
..crate::FutureIncompatibleInfo::default_fields_for_macro()
}),
..crate::Lint::default_fields_for_macro()
};declare_lint! {
5649/// The `float_literal_f32_fallback` lint detects situations where the type of an unsuffixed
5650 /// float literal falls back to `f32` instead of `f64` to avoid a compilation error. This occurs
5651 /// when there is a trait bound `f32: From<T>` (or equivalent, such as `T: Into<f32>`) and the
5652 /// literal is inferred to have the same type as `T`.
5653 ///
5654 /// ### Example
5655 ///
5656 /// ```rust
5657 /// fn foo(x: impl Into<f32>) -> f32 {
5658 /// x.into()
5659 /// }
5660 ///
5661 /// fn main() {
5662 /// dbg!(foo(2.5));
5663 /// }
5664 /// ```
5665 ///
5666 /// {{produces}}
5667 ///
5668 /// ### Explanation
5669 ///
5670 /// Rust allows traits that are only implemented for a single floating point type to guide type
5671 /// inference for floating point literals. This used to apply in the case of `f32: From<T>`
5672 /// (where `T` was inferred to be the same type as a floating point literal), as the only
5673 /// floating point type impl was `f32: From<f32>`. However, as Rust is in the process of adding
5674 /// support for `f16`, there are now two implementations for floating point types:
5675 /// `f32: From<f16>` and `f32: From<f32>`. This means that the trait bound `f32: From<T>` can no
5676 /// longer guide inference for the type of the floating point literal. The default fallback for
5677 /// unsuffixed floating point literals is `f64`. As `f32` does not implement `From<f64>`,
5678 /// falling back to `f64` would cause a compilation error; therefore, the float type fallback
5679 /// has been tempoarily adjusted to fallback to `f32` in this scenario.
5680 ///
5681 /// The lint will automatically provide a machine-applicable suggestion to add a `_f32` suffix
5682 /// to the literal, which will fix the problem.
5683 ///
5684 /// This is a [future-incompatible] lint to transition this to a hard error in the future. See
5685 /// [issue #154024] for more details.
5686 ///
5687 /// [issue #154024]: https://github.com/rust-lang/rust/issues/154024
5688 /// [future-incompatible]: ../index.md#future-incompatible-lints
5689pub FLOAT_LITERAL_F32_FALLBACK,
5690 Warn,
5691"detects unsuffixed floating point literals whose type fallback to `f32`",
5692 @future_incompatible = FutureIncompatibleInfo {
5693 reason: fcw!(FutureReleaseError #154024),
5694 report_in_deps: false,
5695 };
5696}