tokio-rs/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2026-09-08 00:00:13 +02:00
Code Issues Packages Projects Releases Wiki Activity

sync: improve CancellationToken doc on child tokens (#5632)

Browse Source
This commit is contained in:
Sigurd
2023-04-19 17:42:32 +02:00
committed by GitHub
parent db543639e1
commit 5cef6eba7b
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio-util/src/sync/cancellation_token.rs
+4 -1
View File
@@ -97,6 +97,8 @@ impl core::fmt::Debug for CancellationToken {
} }
impl Clone for CancellationToken { impl Clone for CancellationToken {
/// Creates a clone of the `CancellationToken` which will get cancelled
/// whenever the current token gets cancelled, and vice versa.
fn clone(&self) -> Self { fn clone(&self) -> Self {
tree_node::increase_handle_refcount(&self.inner); tree_node::increase_handle_refcount(&self.inner);
CancellationToken { CancellationToken {
@@ -126,7 +128,8 @@ impl CancellationToken {
} }
/// Creates a `CancellationToken` which will get cancelled whenever the /// Creates a `CancellationToken` which will get cancelled whenever the
/// current token gets cancelled. /// current token gets cancelled. Unlike a cloned `CancellationToken`,
/// cancelling a child token does not cancel the parent token.
/// ///
/// If the current token is already cancelled, the child token will get /// If the current token is already cancelled, the child token will get
/// returned in cancelled state. /// returned in cancelled state.