time: document Interval::tick cancel safety (tokio-rs#4152)

oliver-giersch · Oct 28, 2021 · 59f5147 · 59f5147
1 parent 715c1ca
commit 59f5147
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tokio/src/time/interval.rs b/tokio/src/time/interval.rs
@@ -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
     ///
     /// ```