itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-09-25 12:00:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document that timeout-ed futures will be polled at least once (#603)

Browse Source 
tokio-util: document behavior of `StreamExt::timeout` when timeout = 0
This commit is contained in:
Léo Gaspard 2018-08-31 22:26:41 +09:00 committed by Toby Lawrence
parent 322a94f72f
commit 3a59526523
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/util/future.rs
View File

@ -31,6 +31,9 @@ pub trait FutureExt: Future {
/// If the future completes before `timeout` then the future will resolve
/// with that item. Otherwise the future will resolve to an error.
///
/// The future is guaranteed to be polled at least once, even if `timeout`
/// is set to zero.
///
/// # Examples
///
/// ```
@ -69,3 +72,16 @@ pub trait FutureExt: Future {
}
impl<T: ?Sized> FutureExt for T where T: Future {}
#[cfg(test)]
mod test {
use super::*;
use prelude::future;
#[test]
fn timeout_polls_at_least_once() {
let base_future = future::result::<(), ()>(Ok(()));
let timeouted_future = base_future.timeout(Duration::new(0, 0));
assert!(timeouted_future.wait().is_ok());
}
}