sync: add JoinHandle::abort (#2474)

This commit is contained in:
John-John Tedro
2020-09-08 20:52:57 -07:00
committed by GitHub
parent a0a356152e
commit cbb14a7bb9
+38
View File
@@ -157,6 +157,44 @@ impl<T> JoinHandle<T> {
_p: PhantomData,
}
}
/// Abort the task associated with the handle.
///
/// Awaiting a cancelled task might complete as usual if the task was
/// already completed at the time it was cancelled, but most likely it
/// will complete with a `Err(JoinError::Cancelled)`.
///
/// ```rust
/// use tokio::time;
///
/// #[tokio::main]
/// async fn main() {
/// let mut handles = Vec::new();
///
/// handles.push(tokio::spawn(async {
/// time::delay_for(time::Duration::from_secs(10)).await;
/// true
/// }));
///
/// handles.push(tokio::spawn(async {
/// time::delay_for(time::Duration::from_secs(10)).await;
/// false
/// }));
///
/// for handle in &handles {
/// handle.abort();
/// }
///
/// for handle in handles {
/// assert!(handle.await.unwrap_err().is_cancelled());
/// }
/// }
/// ```
pub fn abort(&self) {
if let Some(raw) = self.raw {
raw.shutdown();
}
}
}
impl<T> Unpin for JoinHandle<T> {}