Skip to content
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

Jump to bottom

Doc change for when timeouts may not fire. #5126

Merged
merged 2 commits into from Oct 29, 2022
Merged

Doc change for when timeouts may not fire. #5126

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c25897b
Doc change for when timeouts may not fire.
rthomas Oct 26, 2022
2e6b6c7
Update tokio/src/time/timeout.rs
rthomas Oct 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions tokio/src/time/timeout.rs
View file
Open in desktop
Expand Up @@ -21,6 +21,10 @@ use std::task::{self, Poll};
/// value is returned. Otherwise, an error is returned and the future is
/// canceled.
///
/// Note that the timeout is checked before polling the future, so if the future
/// does not yield during execution then it is possible for the future to complete
/// and exceed the timeout _without_ returning an error.
///
/// This function returns a future whose return type is [`Result`]`<T,`[`Elapsed`]`>`, where `T` is the
/// return type of the provided future.
///
Expand Down