Clippy lints / Style
Clippy lint · Style · checked with Clippy 0.1.99
clippy::mut_mutex_lock: calling `&mut Mutex::lock` unnecessarily locks an exclusive (mutable) reference
What it meansChecks for &mut Mutex::lock calls It is in the style group and warns by default.
What you see
warning: calling `&mut Mutex::lock` unnecessarily locks an exclusive (mutable) reference --> main.rs:8:29 | 8 | let mut value = value_mutex.lock().unwrap(); | ^^^^ help: change this to: `get_mut` | = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#mut_mutex_lock = note: `#[warn(clippy::mut_mutex_lock)]` on by default
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?
Mutex::lock is less efficient than calling Mutex::get_mut. In addition you also have a statically guarantee that the mutex isn’t locked, instead of just a runtime guarantee.
Code that works but is not idiomatic Rust. 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
use std::sync::{Arc, Mutex};
let mut value_rc = Arc::new(Mutex::new(42_u8));
let value_mutex = Arc::get_mut(&mut value_rc).unwrap();
let mut value = value_mutex.lock().unwrap();
*value += 1;
Write this instead
use std::sync::{Arc, Mutex};
let mut value_rc = Arc::new(Mutex::new(42_u8));
let value_mutex = Arc::get_mut(&mut value_rc).unwrap();
let value = value_mutex.get_mut().unwrap();
*value += 1;
Turn it off, or on
Allow it where it does not fit your code, as narrowly as you can:
On one item
#[allow(clippy::mut_mutex_lock)]
fn my_function() { /* ... */ }Whole crate (Cargo.toml)
[lints.clippy]
mut_mutex_lock = "allow"One run
cargo clippy -- -A clippy::mut-mutex-lockThe [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 &mut Mutex::lock calls
Why is this bad?
Mutex::lock is less efficient than
calling Mutex::get_mut. In addition you also have a statically
guarantee that the mutex isn’t locked, instead of just a runtime
guarantee.
Example
use std::sync::{Arc, Mutex};
let mut value_rc = Arc::new(Mutex::new(42_u8));
let value_mutex = Arc::get_mut(&mut value_rc).unwrap();
let mut value = value_mutex.lock().unwrap();
*value += 1;
Use instead:
use std::sync::{Arc, Mutex};
let mut value_rc = Arc::new(Mutex::new(42_u8));
let value_mutex = Arc::get_mut(&mut value_rc).unwrap();
let value = value_mutex.get_mut().unwrap();
*value += 1;
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- needless_returnunneeded `return` statement
- new_without_defaultChecks for public types with a pub fn new() -> Self method and no implementation of Default
- len_zeroChecks for getting the length of something via .len() just to compare to zero, and suggests using .is_empty() where applicable
- module_inceptionChecks for modules that have the same name as their parent module
- multiple_bound_locationsbound is defined in more than one place
- must_use_unitthis unit-returning function has a `#[must_use]` attribute
- needless_borrowthis expression creates a reference which is immediately dereferenced by the compiler
- needless_borrows_for_generic_argsthe borrowed expression implements the required traits
- needless_doctest_mainChecks for fn main() {
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::needless_returnunneeded `return` statementRead it next →Did this answer your question?