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

macros: define cancellation safety (#5525)

Browse Source
This commit is contained in:
Alice Ryhl
2023-03-18 21:25:23 +00:00
committed by GitHub
parent e7bd754231
commit cef98e25e7
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/macros/select.rs
+7
View File
@@ -131,6 +131,13 @@
/// correctly even if it is restarted while waiting at an `.await`, then it is /// correctly even if it is restarted while waiting at an `.await`, then it is
/// cancellation safe. /// cancellation safe.
/// ///
/// Cancellation safety can be defined in the following way: If you have a
/// future that has not yet completed, then it must be a no-op to drop that
/// future and recreate it. This definition is motivated by the situation where
/// a `select!` is used in a loop. Without this guarantee, you would lose your
/// progress when another branch completes and you restart the `select!` by
/// going around the loop.
///
/// Be aware that cancelling something that is not cancellation safe is not /// Be aware that cancelling something that is not cancellation safe is not
/// necessarily wrong. For example, if you are cancelling a task because the /// necessarily wrong. For example, if you are cancelling a task because the
/// application is shutting down, then you probably don't care that partially /// application is shutting down, then you probably don't care that partially