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

time: document Interval::tick cancel safety (#4152)

Browse Source
This commit is contained in:
Alice Ryhl
2021-10-05 15:55:15 +02:00
committed by GitHub
parent c5d37204dc
commit d047584e86
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/time/interval.rs
+5
View File
@@ -367,6 +367,11 @@ pub struct Interval {
impl Interval {
/// Completes when the next instant in the interval has been reached.
///
/// # Cancel safety
///
/// This method is cancellation safe. If `tick` is used as the branch in a `tokio::select!` and
/// another branch completes first, then no tick has been consumed.
///
/// # Examples
///
/// ```