Lint Configuration Options

Allowed names below the minimum allowed characters. The value ".." can be used as part of the list to indicate, that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value.

Default Value: ["j", "z", "i", "y", "n", "x", "w"]

Affected lints:

min_ident_chars

`allowed-prefixes`

List of prefixes to allow when determining whether an item's name ends with the module's name. If the rest of an item's name is an allowed prefix (e.g. item ToFoo or to_foo in module foo), then don't emit a warning.

Example

allowed-prefixes = [ "to", "from" ]

Noteworthy

By default, the following prefixes are allowed: to, as, into, from, try_into and try_from
PascalCase variant is included automatically for each snake_case variant (e.g. if try_into is included, TryInto will also be included)
Use ".." as part of the list to indicate that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value

Default Value: ["to", "as", "into", "from", "try_into", "try_from"]

Affected lints:

module_name_repetitions

`allowed-scripts`

The list of unicode scripts allowed to be used in the scope.

Default Value: ["Latin"]

Affected lints:

disallowed_script_idents

`allowed-wildcard-imports`

List of path segments allowed to have wildcard imports.

Example

allowed-wildcard-imports = [ "utils", "common" ]

Noteworthy

This configuration has no effects if used with warn_on_all_wildcard_imports = true.
Paths with any segment that containing the word 'prelude' are already allowed by default.

Default Value: []

Affected lints:

wildcard_imports

`arithmetic-side-effects-allowed`

Suppress checking of the passed type names in all types of operations.

If a specific operation is desired, consider using arithmetic_side_effects_allowed_binary or arithmetic_side_effects_allowed_unary instead.

Example

arithmetic-side-effects-allowed = ["SomeType", "AnotherType"]

Noteworthy

A type, say SomeType, listed in this configuration has the same behavior of ["SomeType" , "*"], ["*", "SomeType"] in arithmetic_side_effects_allowed_binary.

Default Value: []

Affected lints:

arithmetic_side_effects

`arithmetic-side-effects-allowed-binary`

Suppress checking of the passed type pair names in binary operations like addition or multiplication.

Supports the "*" wildcard to indicate that a certain type won't trigger the lint regardless of the involved counterpart. For example, ["SomeType", "*"] or ["*", "AnotherType"].

Pairs are asymmetric, which means that ["SomeType", "AnotherType"] is not the same as ["AnotherType", "SomeType"].

Example

arithmetic-side-effects-allowed-binary = [["SomeType" , "f32"], ["AnotherType", "*"]]

Default Value: []

Affected lints:

arithmetic_side_effects

`arithmetic-side-effects-allowed-unary`

Suppress checking of the passed type names in unary operations like "negation" (-).

Example

arithmetic-side-effects-allowed-unary = ["SomeType", "AnotherType"]

Default Value: []

Affected lints:

arithmetic_side_effects

`array-size-threshold`

The maximum allowed size for arrays on the stack

Default Value: 512000

Affected lints:

`avoid-breaking-exported-api`

Suppress lints whenever the suggested change would cause breakage for other crates.

Default Value: true

Affected lints:

`await-holding-invalid-types`

Default Value: []

Affected lints:

await_holding_invalid_type

`cargo-ignore-publish`

For internal testing only, ignores the current publish settings in the Cargo manifest.

Default Value: false

Affected lints:

cargo_common_metadata

`check-private-items`

Whether to also run the listed lints on private items.

Default Value: false

Affected lints:

`cognitive-complexity-threshold`

The maximum cognitive complexity a function can have

Default Value: 25

Affected lints:

cognitive_complexity

`disallowed-macros`

The list of disallowed macros, written as fully qualified paths.

Default Value: []

Affected lints:

disallowed_macros

`disallowed-methods`

The list of disallowed methods, written as fully qualified paths.

Default Value: []

Affected lints:

disallowed_methods

`disallowed-names`

The list of disallowed names to lint about. NB: bar is not here since it has legitimate uses. The value ".." can be used as part of the list to indicate that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value.

Default Value: ["foo", "baz", "quux"]

Affected lints:

disallowed_names

`disallowed-types`

The list of disallowed types, written as fully qualified paths.

Default Value: []

Affected lints:

disallowed_types

`doc-valid-idents`

The list of words this lint should not consider as identifiers needing ticks. The value ".." can be used as part of the list to indicate, that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value. For example:

doc-valid-idents = ["ClipPy"] would replace the default list with ["ClipPy"].
doc-valid-idents = ["ClipPy", ".."] would append ClipPy to the default list.

Default Value: ["KiB", "MiB", "GiB", "TiB", "PiB", "EiB", "DirectX", "ECMAScript", "GPLv2", "GPLv3", "GitHub", "GitLab", "IPv4", "IPv6", "ClojureScript", "CoffeeScript", "JavaScript", "PureScript", "TypeScript", "WebAssembly", "NaN", "NaNs", "OAuth", "GraphQL", "OCaml", "OpenDNS", "OpenGL", "OpenMP", "OpenSSH", "OpenSSL", "OpenStreetMap", "OpenTelemetry", "WebGL", "WebGL2", "WebGPU", "TensorFlow", "TrueType", "iOS", "macOS", "FreeBSD", "TeX", "LaTeX", "BibTeX", "BibLaTeX", "MinGW", "CamelCase"]

Affected lints:

doc_markdown

`enable-raw-pointer-heuristic-for-send`

Whether to apply the raw pointer heuristic to determine if a type is Send.

Default Value: true

Affected lints:

non_send_fields_in_send_ty

`enforce-iter-loop-reborrow`

Whether to recommend using implicit into iter for reborrowed values.

Example

let mut vec = vec![1, 2, 3];
let rmvec = &mut vec;
for _ in rmvec.iter() {}
for _ in rmvec.iter_mut() {}

Use instead:

let mut vec = vec![1, 2, 3];
let rmvec = &mut vec;
for _ in &*rmvec {}
for _ in &mut *rmvec {}

Default Value: false

Affected lints:

explicit_iter_loop

`enforced-import-renames`

The list of imports to always rename, a fully qualified path followed by the rename.

Default Value: []

Affected lints:

missing_enforced_import_renames

`enum-variant-name-threshold`

The minimum number of enum variants for the lints about variant names to trigger

Default Value: 3

Affected lints:

enum_variant_names

`enum-variant-size-threshold`

The maximum size of an enum's variant to avoid box suggestion

Default Value: 200

Affected lints:

large_enum_variant

`excessive-nesting-threshold`

The maximum amount of nesting a block can reside in

Default Value: 0

Affected lints:

excessive_nesting

`future-size-threshold`

The maximum byte size a Future can have, before it triggers the clippy::large_futures lint

Default Value: 16384

Affected lints:

large_futures

`ignore-interior-mutability`

A list of paths to types that should be treated like Arc, i.e. ignored but for the generic parameters for determining interior mutability

Default Value: ["bytes::Bytes"]

Affected lints:

`large-error-threshold`

The maximum size of the Err-variant in a Result returned from a function

Default Value: 128

Affected lints:

result_large_err

`literal-representation-threshold`

The lower bound for linting decimal literals

Default Value: 16384

Affected lints:

decimal_literal_representation

`matches-for-let-else`

Whether the matches should be considered by the lint, and whether there should be filtering for common types.

Default Value: "WellKnownTypes"

Affected lints:

manual_let_else

`max-fn-params-bools`

The maximum number of bool parameters a function can have

Default Value: 3

Affected lints:

fn_params_excessive_bools

`max-include-file-size`

The maximum size of a file included via include_bytes!() or include_str!(), in bytes

Default Value: 1000000

Affected lints:

large_include_file

`max-struct-bools`

The maximum number of bool fields a struct can have

Default Value: 3

Affected lints:

struct_excessive_bools

`max-suggested-slice-pattern-length`

When Clippy suggests using a slice pattern, this is the maximum number of elements allowed in the slice pattern that is suggested. If more elements are necessary, the lint is suppressed. For example, [_, _, _, e, ..] is a slice pattern with 4 elements.

Default Value: 3

Affected lints:

index_refutable_slice

`max-trait-bounds`

The maximum number of bounds a trait can have to be linted

Default Value: 3

Affected lints:

type_repetition_in_bounds

`min-ident-chars-threshold`

Minimum chars an ident can have, anything below or equal to this will be linted.

Default Value: 1

Affected lints:

min_ident_chars

`missing-docs-in-crate-items`

Whether to only check for missing documentation in items visible within the current crate. For example, pub(crate) items.

Default Value: false

Affected lints:

missing_docs_in_private_items

`msrv`

The minimum rust version that the project supports. Defaults to the rust-version field in Cargo.toml

Affected lints:

`pass-by-value-size-limit`

The minimum size (in bytes) to consider a type for passing by reference instead of by value.

Default Value: 256

Affected lints:

large_types_passed_by_value

`pub-underscore-fields-behavior`

Lint "public" fields in a struct that are prefixed with an underscore based on their exported visibility, or whether they are marked as "pub".

Default Value: "PubliclyExported"

Affected lints:

pub_underscore_fields

`semicolon-inside-block-ignore-singleline`

Whether to lint only if it's multiline.

Default Value: false

Affected lints:

semicolon_inside_block

`semicolon-outside-block-ignore-multiline`

Whether to lint only if it's singleline.

Default Value: false

Affected lints:

semicolon_outside_block

`single-char-binding-names-threshold`

The maximum number of single char bindings a scope may have

Default Value: 4

Affected lints:

many_single_char_names

`stack-size-threshold`

The maximum allowed stack size for functions in bytes

Default Value: 512000

Affected lints:

large_stack_frames

`standard-macro-braces`

Enforce the named macros always use the braces specified.

A MacroMatcher can be added like so { name = "macro_name", brace = "(" }. If the macro could be used with a full path two MacroMatchers have to be added one with the full path crate_name::macro_name and one with just the macro name.

Default Value: []

Affected lints:

nonstandard_macro_braces

`struct-field-name-threshold`

The minimum number of struct fields for the lints about field names to trigger

Default Value: 3

Affected lints:

struct_field_names

`suppress-restriction-lint-in-const`

Whether to suppress a restriction lint in constant code. In same cases the restructured operation might not be unavoidable, as the suggested counterparts are unavailable in constant code. This configuration will cause restriction lints to trigger even if no suggestion can be made.

Default Value: false

Affected lints: