std: suggest OnceLock over Once #126509
Merged
std: suggest OnceLock over Once #126509
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
rustbot
added
S-waiting-on-review
jhpratt
reviewed
Jun 15, 2024
library/std/src/sync/once.rs
Outdated
| /// functionality. This type can only be constructed with [`Once::new()`]. | ||
| /// A low-level synchronization primitive for one-time global execution. | ||
| /// | ||
| /// Once this was the only "execute once" synchronization provided by `std`. |
There was a problem hiding this comment.
Suggested change
| /// Once this was the only "execute once" synchronization provided by `std`. | |
| /// Previously, this was the only "execute once" synchronization provided by `std`. |
to avoid confusion with the type name
There was a problem hiding this comment.
Aw, so much for sneaking that one by. 😉
There was a problem hiding this comment.
Once upon a time... well, I suppose that is a bit cliche now.
There was a problem hiding this comment.
If it was intentional, so be it 😆 But I think it would be mildly confusing — my brain parsed it wrong at first.
workingjubilee
force-pushed
the
gently-discourage-doing-things-once
branch
from
08da712
to
b8eb6ad
Compare
|
@bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jun 15, 2024
…iaskrgr Rollup of 9 pull requests Successful merges: - rust-lang#126354 (Use `Variance` glob imported variants everywhere) - rust-lang#126367 (Point out failing never obligation for `DEPENDENCY_ON_UNIT_NEVER_TYPE_FALLBACK`) - rust-lang#126469 (MIR Shl/Shr: the offset can be computed with rem_euclid) - rust-lang#126471 (Use a consistent way to filter out bounds instead of splitting it into three places) - rust-lang#126472 (build `libcxx-version` only when it doesn't exist) - rust-lang#126497 (delegation: Fix hygiene for `self`) - rust-lang#126501 (make bors ignore comments in PR template) - rust-lang#126509 (std: suggest OnceLock over Once) - rust-lang#126512 (Miri subtree update) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jun 15, 2024
Rollup merge of rust-lang#126509 - workingjubilee:gently-discourage-doing-things-once, r=jhpratt std: suggest OnceLock over Once It was noted in rust-lang#125615 (comment) that Once is not necessary in most cases and should be discouraged. Once is really just an implementation detail of OnceLock that others can use if they want. Suggest they use OnceLock instead.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
It was noted in #125615 (comment) that Once is not necessary in most cases and should be discouraged. Once is really just an implementation detail of OnceLock that others can use if they want. Suggest they use OnceLock instead.