Skip to content

sync: document cancel safety on SetOnce::wait #7506

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

Merged
merged 1 commit into from
Aug 3, 2025
Merged

sync: document cancel safety on SetOnce::wait #7506

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions tokio/src/sync/set_once.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,17 +338,14 @@ impl<T> SetOnce<T> {
}
}

/// Waits until set is called. The future returned will keep blocking until
/// the `SetOnce` is initialized.
/// Waits until the value is set.
///
/// If the `SetOnce` is already initialized, it will return the value
/// immediately.
///
/// # Note
/// # Cancel safety
///
/// This will keep waiting until the `SetOnce` is initialized, so it
/// should be used with care to avoid blocking the current task
/// indefinitely.
/// This method is cancel safe.
pub async fn wait(&self) -> &T {
loop {
if let Some(val) = self.get() {
Expand Down
Loading