Skip to content

time: document immediate completion guarantee for timeouts #5509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Darksonn merged 2 commits into from
Feb 27, 2023
Merged

time: document immediate completion guarantee for timeouts #5509

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
591faea
time: document immediate completion guarantee for timeouts
zetanumbers Feb 27, 2023
b899f69
time: fix timeout documentation error
zetanumbers Feb 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions tokio/src/time/timeout.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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
///
Expand Down Expand Up @@ -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 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
///
Expand Down