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.

Sign up for GitHub

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

Jump to bottom

Tracking Issue for the Wake trait #69912

Closed
3 tasks
KodrAus opened this issue Mar 11, 2020 · 4 comments
Closed
3 tasks

Tracking Issue for the Wake trait #69912

KodrAus opened this issue Mar 11, 2020 · 4 comments
Labels
A-async-await Area: Async & Await AsyncAwait-Triaged Async-await issues that have been triaged during a working group meeting. B-unstable Blocker: Implemented in the nightly compiler and unstable. C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC Libs-Tracked Libs issues that are tracked on the team's project board. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.

Comments

@KodrAus
Copy link
Contributor

KodrAus commented Mar 11, 2020

This is a tracking issue for the Wake trait.
The feature gate for the issue is #![feature(wake_trait)].

About tracking issues

Tracking issues are used to record the overall progress of implementation.
They are also uses as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

Steps

Unresolved Questions

Implementation history
@KodrAus KodrAus added the C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC label Mar 11, 2020
@Centril Centril added T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. A-async-await Area: Async & Await labels Mar 11, 2020
@jonas-schievink jonas-schievink added the B-unstable Blocker: Implemented in the nightly compiler and unstable. label Mar 11, 2020
@tmandry tmandry added the AsyncAwait-Triaged Async-await issues that have been triaged during a working group meeting. label Mar 17, 2020
@phil-opp phil-opp mentioned this issue Mar 22, 2020
Merged
@yoshuawuyts yoshuawuyts mentioned this issue Apr 4, 2020
Closed
@yoshuawuyts yoshuawuyts mentioned this issue Jul 13, 2020
Merged
@yoshuawuyts
Copy link
Member

Filed a stabilization PR: #74304

@yoshuawuyts
Copy link
Member

These are the uses the Wake trait will replace:

This is mostly a useful helper to enable people to safely author Waker impls through, which is useful during testing, teaching, and when you only have a single callback that needs to be called when woken.

@KodrAus KodrAus added the Libs-Tracked Libs issues that are tracked on the team's project board. label Jul 29, 2020
@taiki-e
Copy link
Member

taiki-e commented Sep 25, 2020

@yoshuawuyts

These are the uses the Wake trait will replace:

I believe futures::task::ArcWake should be added to that list.

m-ou-se added a commit to m-ou-se/rust that referenced this issue Feb 4, 2021
@m-ou-se
Rollup merge of rust-lang#74304 - yoshuawuyts:stabilize-wake, r=KodrAus
64c5354 
Stabilize the Wake trait

This PR proposes stabilizing the `wake_trait` feature, tracking issue rust-lang#69912.

## Motivation

The surface area this trait introduces is small, and it has been on nightly for 4 months without any reported issues. Given the surface area of this trait is small and only serves to provide a safe interface around the already stable [`std::task::RawWakerVTable`](https://doc.rust-lang.org/std/task/struct.RawWaker.html) it seems unlikely this trait will require any further changes. So I'm proposing we stabilize this.

Personally I would love to have this available on stable, since it would enable cleaning up some runtime internals by removing the tedious pointer required to construct a [`RawWakerVTable`](https://doc.rust-lang.org/std/task/struct.RawWakerVTable.html). I believe the intent was always to introduce a `Wake` counterpart to `RawWaker` in order to safely construct `Waker` instances. And the `Wake` trait feels like it does that job as intended.

## Implementation notes

This PR itself fixes a link in the docs, and introduces an example of how to use the trait: a minimal `block_on` example that runs a future to completion on the current thread. It doesn't include fancier features such as support for nesting, but is intended to serve as a teaching device for both `task::Wake` and futures alike.
m-ou-se added a commit to m-ou-se/rust that referenced this issue Feb 4, 2021
@m-ou-se
Rollup merge of rust-lang#74304 - yoshuawuyts:stabilize-wake, r=KodrAus
d20d097 
Stabilize the Wake trait

This PR proposes stabilizing the `wake_trait` feature, tracking issue rust-lang#69912.

## Motivation

The surface area this trait introduces is small, and it has been on nightly for 4 months without any reported issues. Given the surface area of this trait is small and only serves to provide a safe interface around the already stable [`std::task::RawWakerVTable`](https://doc.rust-lang.org/std/task/struct.RawWaker.html) it seems unlikely this trait will require any further changes. So I'm proposing we stabilize this.

Personally I would love to have this available on stable, since it would enable cleaning up some runtime internals by removing the tedious pointer required to construct a [`RawWakerVTable`](https://doc.rust-lang.org/std/task/struct.RawWakerVTable.html). I believe the intent was always to introduce a `Wake` counterpart to `RawWaker` in order to safely construct `Waker` instances. And the `Wake` trait feels like it does that job as intended.

## Implementation notes

This PR itself fixes a link in the docs, and introduces an example of how to use the trait: a minimal `block_on` example that runs a future to completion on the current thread. It doesn't include fancier features such as support for nesting, but is intended to serve as a teaching device for both `task::Wake` and futures alike.
@memoryruins
Copy link
Contributor

The Wake trait was stabilized in #74304 and is now on stable rustc 1.51.0.
Thanks everyone who helped see this through!

@jyn514 jyn514 closed this as completed Apr 26, 2021
@ebkalderon ebkalderon mentioned this issue Feb 23, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-async-await Area: Async & Await AsyncAwait-Triaged Async-await issues that have been triaged during a working group meeting. B-unstable Blocker: Implemented in the nightly compiler and unstable. C-tracking-issue Category: An issue tracking the progress of sth. like the implementation of an RFC Libs-Tracked Libs issues that are tracked on the team's project board. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@Centril @jonas-schievink @tmandry @yoshuawuyts @KodrAus @memoryruins @jyn514 @taiki-e