Clippy lints / Complexity
Clippy lint · Complexity · checked with Clippy 0.1.99
clippy::unnecessary_unwrap_unchecked: usage of `unwrap_unchecked` when an `_unchecked` variant of the function exists
What it meansChecks for calls to unwrap_unchecked when an _unchecked variant of the function exists. It is in the complexity group and warns by default.
What you see
warning: usage of `unwrap_unchecked` when an `_unchecked` variant of the function exists --> main.rs:3:18 | 3 | let s = unsafe { std::str::from_utf8(&[]).unwrap_unchecked() }; | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#unnecessary_unwrap_unchecked = note: `#[warn(clippy::unnecessary_unwrap_unchecked)]` on by default help: use `std::str::from_utf8_unchecked` instead, and remove the call to `.unwrap_unchecked()` | 3 - let s = unsafe { std::str::from_utf8(&[]).unwrap_unchecked() }; 3 + let s = unsafe { std::str::from_utf8_unchecked(&[]) }; |
Real output of Clippy 0.1.99 (Rust 1.99) on the example below. Names and line numbers in yours will differ.
Does it matter?
Calling the non-unchecked variant may result in checking that is then discarded if unwrap_unchecked is called directly afterwards, whereas the unchecked variant most likely avoids performing the check completely.
Code that does something simple in a complicated way. Warns by default.
How to fix it
Clippy does not fix this one automatically (its suggestion may change behaviour, so it only shows it). Change the code by hand:
Flagged
let s = unsafe { std::str::from_utf8(&[]).unwrap_unchecked() };
Write this instead
let s = unsafe { std::str::from_utf8_unchecked(&[]) };
Turn it off, or on
Allow it where it does not fit your code, as narrowly as you can:
On one item
#[allow(clippy::unnecessary_unwrap_unchecked)]
fn my_function() { /* ... */ }Whole crate (Cargo.toml)
[lints.clippy]
unnecessary_unwrap_unchecked = "allow"One run
cargo clippy -- -A clippy::unnecessary-unwrap-uncheckedThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Clippy's own documentation
What it does
Checks for calls to unwrap_unchecked when an _unchecked variant of the function exists.
Why is this bad?
Calling the non-unchecked variant may result in checking that is then discarded
if unwrap_unchecked is called directly afterwards, whereas the unchecked
variant most likely avoids performing the check completely.
Known problems
The unchecked variant is only suggested if it’s defined in the same impl block
as the non-unchecked one
Example
let s = unsafe { std::str::from_utf8(&[]).unwrap_unchecked() };
Use instead:
let s = unsafe { std::str::from_utf8_unchecked(&[]) };
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- too_many_argumentsChecks for functions with too many parameters
- clone_on_copyusing `clone` on type `u64` which implements the `Copy` trait
- type_complexityChecks for types used in structs, parameters and let declarations above a certain complexity threshold
- unnecessary_operationChecks for expression statements that can be reduced to a sub-expression
- unnecessary_sort_byChecks for usage of Vec::sort_by passing in a closure which compares the two arguments, either directly or indirectly
- unnecessary_unwrapChecks for calls of unwrap[_err]() that cannot fail
- unneeded_wildcard_patternthis pattern is unneeded as the `..` pattern can match that element
- unused_format_specsformat specifiers have no effect on `format_args!()`
- useless_asrefChecks for usage of .as_ref() or .as_mut() where the types before and after the call are the same
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::too_many_argumentsChecks for functions with too many parametersRead it next →Did this answer your question?