doc(read): Add number of bytes read to doc

This commit is contained in:
oberien 2016-10-04 13:56:31 +02:00
parent f019f5f5bb
commit b0033eb463

View File

@ -13,8 +13,8 @@ enum State<R, T> {
/// Tries to read some bytes directly into the given `buf` in asynchronous
/// manner, returning a future type.
///
/// The returned future will resolve to both the I/O stream as well as the
/// buffer once the read operation is completed.
/// The returned future will resolve to both the I/O stream and the buffer
/// as well as the number of bytes read once the read operation is completed.
pub fn read<R, T>(rd: R, buf: T) -> Read<R, T>
where R: ::std::io::Read,
T: AsMut<[u8]>