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

Fixed docs for Timeout::new and new_at

Browse Source 
They no longer return futures, they return io::Result.
This commit is contained in:
Alex Gaynor
2017-09-22 11:01:34 -04:00
committed by GitHub
parent e33155edb1
commit 24dd856cfd
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/reactor/timeout.rs
+4 -4
View File
@@ -27,8 +27,8 @@ pub struct Timeout {
impl Timeout {
/// Creates a new timeout which will fire at `dur` time into the future.
///
/// This function will return a future that will resolve to the actual
/// timeout object. The timeout object itself is then a future which will be
/// This function will return a Result with the actual timeout object or an
/// error. The timeout object itself is then a future which will be
/// set to fire at the specified point in the future.
pub fn new(dur: Duration, handle: &Handle) -> io::Result<Timeout> {
Timeout::new_at(Instant::now() + dur, handle)
@@ -36,8 +36,8 @@ impl Timeout {
/// Creates a new timeout which will fire at the time specified by `at`.
///
/// This function will return a future that will resolve to the actual
/// timeout object. The timeout object itself is then a future which will be
/// This function will return a Result with the actual timeout object or an
/// error. The timeout object itself is then a future which will be
/// set to fire at the specified point in the future.
pub fn new_at(at: Instant, handle: &Handle) -> io::Result<Timeout> {
Ok(Timeout {