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

Update documentation for AsyncRead and AsyncWrite (#596)

Browse Source 
tokio-io: update documentation for AsyncRead and AsyncWrite
This commit is contained in:
Zachary Stewart
2018-08-31 09:00:32 -04:00
committed by Toby Lawrence
parent c03b23355b
commit 322a94f72f
2 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tokio-io/src/async_write.rs
+8 -7
View File
@@ -13,14 +13,15 @@ use AsyncRead;
/// Specifically, this means that the `write` function will return one of the
/// following:
///
/// * `Ok(n)` means that `n` bytes of data was immediately written .
/// * `Ok(Async::Ready(n))` means that `n` bytes of data was immediately
/// written.
///
/// * `Err(e) if e.kind() == ErrorKind::WouldBlock` means that no data was
/// written from the buffer provided. The I/O object is not currently
/// writable but may become writable in the future. Most importantly, **the
/// current future's task is scheduled to get unparked when the object is
/// readable**. This means that like `Future::poll` you'll receive a
/// notification when the I/O object is writable again.
/// * `Ok(Async::NotReady)` means that no data was written from the buffer
/// provided. The I/O object is not currently writable but may become writable
/// in the future. Most importantly, **the current future's task is scheduled
/// to get unparked when the object is readable**. This means that like
/// `Future::poll` you'll receive a notification when the I/O object is
/// writable again.
///
/// * `Err(e)` for other errors are standard I/O errors coming from the
/// underlying object.