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

time: document immediate completion guarantee for timeouts (#5509)

Browse Source
This commit is contained in:
Daria Sukhonina
2023-02-27 14:17:31 +00:00
committed by GitHub
parent 5a3abe56ee
commit 54aaf3d0e3
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio/src/time/timeout.rs
+10
View File
@@ -28,6 +28,11 @@ use std::task::{self, Poll};
/// This function returns a future whose return type is [`Result`]`<T,`[`Elapsed`]`>`, where `T` is the
/// return type of the provided future.
///
/// If the provided future completes immediatelly, then the future returned from
/// this function is guaranteed to complete immediatelly with an [`Ok`] variant
/// no matter the provided duration.
///
/// [`Ok`]: std::result::Result::Ok
/// [`Result`]: std::result::Result
/// [`Elapsed`]: crate::time::error::Elapsed
///
@@ -100,6 +105,11 @@ where
/// This function returns a future whose return type is [`Result`]`<T,`[`Elapsed`]`>`, where `T` is the
/// return type of the provided future.
///
/// If the provided future completes immediatelly, then the future returned from
/// this function is guaranteed to complete immediatelly with an [`Ok`] variant
/// no matter the provided deadline.
///
/// [`Ok`]: std::result::Result::Ok
/// [`Result`]: std::result::Result
/// [`Elapsed`]: crate::time::error::Elapsed
///