Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: add Mutex::lock_owned and Mutex::try_lock_owned #2571

Merged
merged 2 commits into from
Mar 8, 2022

Conversation

Sherlock-Holo
Copy link
Contributor

Add 2 new methods Mutex::lock_owned and Mutex::try_lock_owned

People who like #1972 want a new method such as poll_lock, to help them implement Future easier and less overhead. But adding poll_lock new method is so hard for the currently Mutex implementation.

However, if #1972 can store the future which returned by Mutex::lock, it can poll the future when poll its MyReceiver. Currently, the Mutex only has lock and try_lock method, which use the &self and the lock return a future but it has a reference to the Mutex. If save the mutex and its MutexLockFuture in a struct, will meet the self-reference problem.

To solve the self-reference problem, add a new way to lock the mutex: Mutex::lock_owned(self: &Arc<Self>) -> OwnedMutexLockFuture<T>, the OwnedMutexLockFuture doesn't reference any variable, it contains the mutex which wrapped by the Arc, so the self-reference problem disappears.

with this PR, #1972 can rewrite like

use futures::lock::Mutex;

struct MySender {
    inner: Arc<Mutex<Inner>>,
}

struct MyReceiver {
    inner: Arc<Mutex<Inner>>,
    fut: Option<OwnedMutexLockFuture<Inner>>,
    guard: Option<OwnedMutexGuard<Inner>>,
}

impl Future for MyReceiver {
    type Output = ();

    fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<()> {
        let this = self.get_mut();

        loop {
            if let Some(_guard) = this.guard.as_mut() {
                todo!()
            } else { 
                match this.fut.as_mut() {
                    None => {
                        this.fut.replace(this.inner.lock_owned());
                    }
                    Some(fut) => {
                        let guard = futures_core::ready!(Pin::new(fut).poll(cx));

                        this.guard.replace(guard);
                    }
                }
            }
        }
    }
}

Copy link
Member

@taiki-e taiki-e left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

futures-util/src/lock/mutex.rs Outdated Show resolved Hide resolved
futures-util/src/lock/mutex.rs Outdated Show resolved Hide resolved
like taiki-e says 'self is always cloned', so take
the self by value is a better way
@taiki-e taiki-e merged commit 8b0f812 into rust-lang:master Mar 8, 2022
@taiki-e taiki-e added 0.3-backport: pending The maintainer accepted to backport this to the 0.3 branch, but backport has not been done yet. A-lock Area: futures::lock labels Mar 8, 2022
@taiki-e taiki-e mentioned this pull request Aug 14, 2022
@taiki-e taiki-e added 0.3-backport: completed and removed 0.3-backport: pending The maintainer accepted to backport this to the 0.3 branch, but backport has not been done yet. labels Aug 14, 2022
@taiki-e taiki-e mentioned this pull request Aug 14, 2022
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Aug 23, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [futures](https://github.com/rust-lang/futures-rs) | dependencies | patch | `0.3.21` -> `0.3.23` |

---

### Release Notes

<details>
<summary>rust-lang/futures-rs</summary>

### [`v0.3.23`](https://github.com/rust-lang/futures-rs/blob/HEAD/CHANGELOG.md#&#8203;0323---2022-08-14)

[Compare Source](rust-lang/futures-rs@0.3.22...0.3.23)

-   Work around MSRV increase due to a cargo bug.

### [`v0.3.22`](https://github.com/rust-lang/futures-rs/blob/HEAD/CHANGELOG.md#&#8203;0322---2022-08-14)

[Compare Source](rust-lang/futures-rs@0.3.21...0.3.22)

-   Fix `Sync` impl of `BiLockGuard` ([#&#8203;2570](rust-lang/futures-rs#2570))
-   Fix partial iteration in `FuturesUnordered` ([#&#8203;2574](rust-lang/futures-rs#2574))
-   Fix false detection of inner panics in `Shared` ([#&#8203;2576](rust-lang/futures-rs#2576))
-   Add `Mutex::lock_owned` and `Mutex::try_lock_owned` ([#&#8203;2571](rust-lang/futures-rs#2571))
-   Add `io::copy_buf_abortable` ([#&#8203;2507](rust-lang/futures-rs#2507))
-   Remove `Unpin` bound from `TryStreamExt::into_async_read` ([#&#8203;2599](rust-lang/futures-rs#2599))
-   Make `run_until_stalled` handle self-waking futures ([#&#8203;2593](rust-lang/futures-rs#2593))
-   Use `FuturesOrdered` in `try_join_all` ([#&#8203;2556](rust-lang/futures-rs#2556))
-   Fix orderings in `LocalPool` waker ([#&#8203;2608](rust-lang/futures-rs#2608))
-   Fix `stream::Chunk` adapters size hints ([#&#8203;2611](rust-lang/futures-rs#2611))
-   Add `push_front` and `push_back` to `FuturesOrdered` ([#&#8203;2591](rust-lang/futures-rs#2591))
-   Deprecate `FuturesOrdered::push` in favor of `FuturesOrdered::push_back` ([#&#8203;2591](rust-lang/futures-rs#2591))
-   Performance improvements ([#&#8203;2583](rust-lang/futures-rs#2583), [#&#8203;2626](rust-lang/futures-rs#2626))
-   Documentation improvements ([#&#8203;2579](rust-lang/futures-rs#2579), [#&#8203;2604](rust-lang/futures-rs#2604), [#&#8203;2613](rust-lang/futures-rs#2613))

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xNTYuMSIsInVwZGF0ZWRJblZlciI6IjMyLjE1Ni4xIn0=-->

Co-authored-by: cabr2-bot <[email protected]>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1507
Reviewed-by: crapStone <[email protected]>
Co-authored-by: Calciumdibromid Bot <[email protected]>
Co-committed-by: Calciumdibromid Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants