sync: add DropGuardRef for CancellationToken (#7407)

This commit is contained in:
yanyuxing
2025-06-18 10:25:41 +02:00
committed by GitHub
parent 99a03a502e
commit b926700065
3 changed files with 41 additions and 1 deletions
+10
View File
@@ -1,6 +1,7 @@
//! An asynchronously awaitable `CancellationToken`.
//! The token allows to signal a cancellation request to one or more tasks.
pub(crate) mod guard;
pub(crate) mod guard_ref;
mod tree_node;
use crate::loom::sync::Arc;
@@ -10,6 +11,7 @@ use core::pin::Pin;
use core::task::{Context, Poll};
use guard::DropGuard;
use guard_ref::DropGuardRef;
use pin_project_lite::pin_project;
/// A token which can be used to signal a cancellation request to one or more
@@ -242,6 +244,14 @@ impl CancellationToken {
DropGuard { inner: Some(self) }
}
/// Creates a `DropGuardRef` for this token.
///
/// Returned guard will cancel this token (and all its children) on drop
/// unless disarmed.
pub fn drop_guard_ref(&self) -> DropGuardRef<'_> {
DropGuardRef { inner: Some(self) }
}
/// Runs a future to completion and returns its result wrapped inside of an `Option`
/// unless the `CancellationToken` is cancelled. In that case the function returns
/// `None` and the future gets dropped.