clippy_utils/
paths.rs

Help
1//! This module contains paths to types and functions Clippy needs to know
2//! about.
3//!
4//! Whenever possible, please consider diagnostic items over hardcoded paths.
5//! See <https://github.com/rust-lang/rust-clippy/issues/5393> for more information.
6
7// Paths inside rustc
8pub const APPLICABILITY: [&str; 2] = ["rustc_lint_defs", "Applicability"];
9pub const APPLICABILITY_VALUES: [[&str; 3]; 4] = [
10    ["rustc_lint_defs", "Applicability", "Unspecified"],
11    ["rustc_lint_defs", "Applicability", "HasPlaceholders"],
12    ["rustc_lint_defs", "Applicability", "MaybeIncorrect"],
13    ["rustc_lint_defs", "Applicability", "MachineApplicable"],
14];
15pub const DIAG: [&str; 2] = ["rustc_errors", "Diag"];
16pub const EARLY_CONTEXT: [&str; 2] = ["rustc_lint", "EarlyContext"];
17pub const EARLY_LINT_PASS: [&str; 3] = ["rustc_lint", "passes", "EarlyLintPass"];
18pub const IDENT: [&str; 3] = ["rustc_span", "symbol", "Ident"];
19pub const IDENT_AS_STR: [&str; 4] = ["rustc_span", "symbol", "Ident", "as_str"];
20pub const KW_MODULE: [&str; 3] = ["rustc_span", "symbol", "kw"];
21pub const LATE_CONTEXT: [&str; 2] = ["rustc_lint", "LateContext"];
22pub const LATE_LINT_PASS: [&str; 3] = ["rustc_lint", "passes", "LateLintPass"];
23pub const LINT: [&str; 2] = ["rustc_lint_defs", "Lint"];
24pub const SYMBOL: [&str; 3] = ["rustc_span", "symbol", "Symbol"];
25pub const SYMBOL_AS_STR: [&str; 4] = ["rustc_span", "symbol", "Symbol", "as_str"];
26pub const SYMBOL_TO_IDENT_STRING: [&str; 4] = ["rustc_span", "symbol", "Symbol", "to_ident_string"];
27pub const SYM_MODULE: [&str; 3] = ["rustc_span", "symbol", "sym"];
28pub const SYNTAX_CONTEXT: [&str; 3] = ["rustc_span", "hygiene", "SyntaxContext"];
29
30// Paths in `core`/`alloc`/`std`. This should be avoided and cleaned up by adding diagnostic items.
31pub const ABORT: [&str; 3] = ["std", "process", "abort"];
32pub const CHILD: [&str; 3] = ["std", "process", "Child"];
33pub const CHILD_ID: [&str; 4] = ["std", "process", "Child", "id"];
34pub const CHILD_KILL: [&str; 4] = ["std", "process", "Child", "kill"];
35pub const PANIC_ANY: [&str; 3] = ["std", "panic", "panic_any"];
36pub const CHAR_IS_ASCII: [&str; 5] = ["core", "char", "methods", "<impl char>", "is_ascii"];
37pub const STDIN: [&str; 4] = ["std", "io", "stdio", "Stdin"];
38
39// Paths in clippy itself
40pub const MSRV: [&str; 3] = ["clippy_utils", "msrvs", "Msrv"];
41
42// Paths in external crates
43#[expect(clippy::invalid_paths)] // internal lints do not know about all external crates
44pub const FUTURES_IO_ASYNCREADEXT: [&str; 3] = ["futures_util", "io", "AsyncReadExt"];
45#[expect(clippy::invalid_paths)] // internal lints do not know about all external crates
46pub const FUTURES_IO_ASYNCWRITEEXT: [&str; 3] = ["futures_util", "io", "AsyncWriteExt"];
47pub const ITERTOOLS_NEXT_TUPLE: [&str; 3] = ["itertools", "Itertools", "next_tuple"];
48pub const PARKING_LOT_MUTEX_GUARD: [&str; 3] = ["lock_api", "mutex", "MutexGuard"];
49pub const PARKING_LOT_RWLOCK_READ_GUARD: [&str; 3] = ["lock_api", "rwlock", "RwLockReadGuard"];
50pub const PARKING_LOT_RWLOCK_WRITE_GUARD: [&str; 3] = ["lock_api", "rwlock", "RwLockWriteGuard"];
51pub const REGEX_BUILDER_NEW: [&str; 3] = ["regex", "RegexBuilder", "new"];
52pub const REGEX_BYTES_BUILDER_NEW: [&str; 4] = ["regex", "bytes", "RegexBuilder", "new"];
53pub const REGEX_BYTES_NEW: [&str; 4] = ["regex", "bytes", "Regex", "new"];
54pub const REGEX_BYTES_SET_NEW: [&str; 4] = ["regex", "bytes", "RegexSet", "new"];
55pub const REGEX_NEW: [&str; 3] = ["regex", "Regex", "new"];
56pub const REGEX_SET_NEW: [&str; 3] = ["regex", "RegexSet", "new"];
57pub const SERDE_DESERIALIZE: [&str; 3] = ["serde", "de", "Deserialize"];
58pub const SERDE_DE_VISITOR: [&str; 3] = ["serde", "de", "Visitor"];
59#[expect(clippy::invalid_paths)] // internal lints do not know about all external crates
60pub const TOKIO_FILE_OPTIONS: [&str; 5] = ["tokio", "fs", "file", "File", "options"];
61#[expect(clippy::invalid_paths)] // internal lints do not know about all external crates
62pub const TOKIO_IO_ASYNCREADEXT: [&str; 5] = ["tokio", "io", "util", "async_read_ext", "AsyncReadExt"];
63#[expect(clippy::invalid_paths)] // internal lints do not know about all external crates
64pub const TOKIO_IO_ASYNCWRITEEXT: [&str; 5] = ["tokio", "io", "util", "async_write_ext", "AsyncWriteExt"];
65#[expect(clippy::invalid_paths)] // internal lints do not know about all external crates
66pub const TOKIO_IO_OPEN_OPTIONS: [&str; 4] = ["tokio", "fs", "open_options", "OpenOptions"];
67#[expect(clippy::invalid_paths)] // internal lints do not know about all external crates
68pub const TOKIO_IO_OPEN_OPTIONS_NEW: [&str; 5] = ["tokio", "fs", "open_options", "OpenOptions", "new"];
clippy_utils/paths.rs

clippy_utils/
paths.rs
