Fix the doc of read_to_end method (#482)

This commit is contained in:
kohensu 2018-07-24 22:57:15 +02:00 committed by Carl Lerche
parent c85bde3170
commit ad4693a18f

View File

@ -29,9 +29,8 @@ enum State<A> {
/// object `A` into the buffer provided.
///
/// In the case of an error the buffer and the object will be discarded, with
/// the error yielded. In the case of success the object will be destroyed and
/// the buffer will be returned, with all data read from the stream appended to
/// the buffer.
/// the error yielded. In the case of success both the object and the buffer
/// will be returned, with all data read from the stream appended to the buffer.
pub fn read_to_end<A>(a: A, buf: Vec<u8>) -> ReadToEnd<A>
where A: AsyncRead,
{