Add documentation about lifetimes to thread::scope. #94763
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rust-highfive
added
the
S-waiting-on-review
10 tasks
m-ou-se
force-pushed
the
scoped-threads-lifetime-docs
branch
from
ff781b7 to
09d0111
Compare
fmease
reviewed
Mar 9, 2022
|
This looks great -- thank you! Very clear and succinct explanation :) r=me with commits squashed |
m-ou-se
force-pushed
the
scoped-threads-lifetime-docs
branch
from
c82b279 to
4d56c15
Compare
|
@bors r=Mark-Simulacrum |
|
📌 Commit 4d56c15 has been approved by |
bors
added
S-waiting-on-bors
|
@bors rollup |
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Mar 9, 2022
…s, r=Mark-Simulacrum Add documentation about lifetimes to thread::scope. This resolves the last unresolved question of rust-lang#93203 This was brought up in rust-lang#94559 (comment) r? ``@Mark-Simulacrum``
matthiaskrgr
added a commit
to matthiaskrgr/rust
that referenced
this pull request
Mar 9, 2022
…s, r=Mark-Simulacrum Add documentation about lifetimes to thread::scope. This resolves the last unresolved question of rust-lang#93203 This was brought up in rust-lang#94559 (comment) r? ```@Mark-Simulacrum```
Dylan-DPC
added a commit
to Dylan-DPC/rust
that referenced
this pull request
Mar 9, 2022
…s, r=Mark-Simulacrum Add documentation about lifetimes to thread::scope. This resolves the last unresolved question of rust-lang#93203 This was brought up in rust-lang#94559 (comment) r? ````@Mark-Simulacrum````
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Mar 10, 2022
…askrgr Rollup of 8 pull requests Successful merges: - rust-lang#91804 (Make some `Clone` impls `const`) - rust-lang#92541 (Mention intent of `From` trait in its docs) - rust-lang#93057 (Add Iterator::collect_into) - rust-lang#94739 (Suggest `if let`/`let_else` for refutable pat in `let`) - rust-lang#94754 (Warn users about `||` in let chain expressions) - rust-lang#94763 (Add documentation about lifetimes to thread::scope.) - rust-lang#94768 (Ignore `close_read_wakes_up` test on SGX platform) - rust-lang#94772 (Add miri to the well known conditional compilation names and values) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
| /// The `'scope` lifetime represents the lifetime of the scope itself. | ||
| /// That is: the time during which new scoped threads may be spawned, | ||
| /// and also the time during which they might still be running. | ||
| /// Once this lifetime ends, all scoped threads are joined. |
There was a problem hiding this comment.
Suggested change
| /// Once this lifetime ends, all scoped threads are joined. | |
| /// By design, this lifetime only ends once all the scoped threads have been joined. |
There was a problem hiding this comment.
I care about this one because that's the right ordering: 'scope by very definition, outlives the Scope and Packet instances, so the right property is rather "once the scoped threads are all joined, this lifetime may end", hence my suggestion
| /// That is: the time during which new scoped threads may be spawned, | ||
| /// and also the time during which they might still be running. | ||
| /// Once this lifetime ends, all scoped threads are joined. | ||
| /// This lifetime starts within the `scope` function, before `f` (the argument to `scope`) starts. |
There was a problem hiding this comment.
It's a bit weird to speak of the beginning of a lifetime, it's not really something that comes up in practice or is important. But I guess it's okay for the sake of explaining stuff:
Suggested change
| /// This lifetime starts within the `scope` function, before `f` (the argument to `scope`) starts. | |
| /// This lifetime "starts" within the `scope` function, before `f` (the argument to `scope`) is called. |
| /// and also the time during which they might still be running. | ||
| /// Once this lifetime ends, all scoped threads are joined. | ||
| /// This lifetime starts within the `scope` function, before `f` (the argument to `scope`) starts. | ||
| /// It ends after `f` returns and all scoped threads have been joined, but before `scope` returns. |
There was a problem hiding this comment.
Suggested change
| /// It ends after `f` returns and all scoped threads have been joined, but before `scope` returns. | |
| /// It ends after `f` returns and all scoped threads have been joined, but before `scope` returns[^hrtb]. | |
| /// | |
| /// [^hrtb]: a property of higher-order (`for<'scope>`) lifetimes. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This resolves the last unresolved question of #93203
This was brought up in #94559 (comment)
r? @Mark-Simulacrum