rust-lang / rust-lang/rust-clippy
Explicit unlock for locks
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
What it does
Force locks to have a dedicated block which lock is acquired at first line of it, or an explicit drop.
Categories
- Kind: Restriction
Why?
Implicit drops can be surprising and some users of linux community forum lwn have some concerns about it that can cause bug in linux kernel. It can also encourage people to free locks sooner.
Drawbacks
None.
Example
fn sample(l: Locked) -> i32 {
let mut x = 2;
let guard = l.lock();
x += 3;
guard.do_sth();
some_other_work_with_lock();
x += 4;
x
}
Could be written as:
fn sample(l: Locked) -> i32 {
let mut x = 2;
{ // lock block
let guard = l.lock();
x += 3;
guard.do_sth();
some_other_work_with_lock();
}
x += 4;
x
}
Or with drop:
fn sample(l: Locked) -> i32 {
let mut x = 2;
let guard = l.lock();
x += 3;
guard.do_sth();
some_other_work_with_lock();
drop(guard);
x += 4;
x
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue contains only Rust examples and does not name implementation files or tests. Start by reviewing Clippy's existing restriction-lint conventions, then determine how the proposed lock block and explicit drop forms should be specified and tested. Done means the behavior is agreed, implemented, and covered by tests for the examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100