doc: note the EOF behaviour of read_until (#3536)

This commit is contained in:
Adam Harvey
2021-02-20 10:22:51 +01:00
committed by GitHub
parent 36d7dab504
commit 53558cb489
+2
View File
@@ -23,6 +23,8 @@ cfg_io_util! {
///
/// If successful, this function will return the total number of bytes read.
///
/// If this function returns `Ok(0)`, the stream has reached EOF.
///
/// # Errors
///
/// This function will ignore all instances of [`ErrorKind::Interrupted`] and