mutex: add OwnedMutexGuard for Arc<Mutex<T>>s
#2455
Conversation
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added
C-enhancement
tokio/src/sync/mutex.rs
Outdated
| /// As long as you have this guard, you have exclusive access to the underlying `T`. The guard | ||
| /// internally keeps a reference-couned pointer to the original `Mutex`, so even if the lock goes | ||
| /// away, the guard remains valid. | ||
| /// | ||
| /// The lock is automatically released whenever the guard is dropped, at which point `lock` | ||
| /// will succeed yet again. |
There was a problem hiding this comment.
Can you wrap these lines at 80 characters like the paragraph above them?
There was a problem hiding this comment.
Sure, will do. There was some existing inconsistent wrapping in this file so I wasn't sure what style to follow.
There was a problem hiding this comment.
The 80 characters ensure that the github view doesn't wrap lines in split mode, at least on my screen, so I like that width. It's also used relatively widely.
There was a problem hiding this comment.
You forgot this paragraph 😅
There was a problem hiding this comment.
I definitely also prefer 80 characters. :) I just also try to avoid changing the wrapping of existing comments that I haven't actually changed, so the git blame is clearer.
| check_send::<MutexGuard<'_, u32>>(); | ||
| check_send::<OwnedMutexGuard<u32>>(); |
There was a problem hiding this comment.
We should consider moving this to tests/async_send_sync.rs, which is not only able to detect missing Send impls, but also able to detect if something is Send when it shouldn't be. The file currently has mostly async functions, but it can handle types too.
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
sorry alice Signed-off-by: Eliza Weisman <eliza@buoyant.io>
|
MSRV test step on CI failed due to a network timeout while installing Rust, I restarted it. |
This PR adds a new
OwnedMutexGuardtype andlock_ownedandtry_lock_ownedmethods forArc<Mutex<T>>. This is pretty much thesame as the similar APIs added in #2421.
I've also corrected some existing documentation that incorrectly
implied that the existing
lockmethod cloned an internalArc— Ithink this may be a holdover from
tokio0.1'sLocktype?Signed-off-by: Eliza Weisman eliza@buoyant.io