authorgravatar for zac@zacoons.comzacoons <zac@zacoons.com> 2026-10-09 14:59:36+10:00
committergravatar for alex@alexrp.comAlex Rønne Petersen <alex@alexrp.com> 2026-10-09 12:10:57+02:00
logcf03d737e4fffc33785a10f7901191311cc8d689
tree64d81212de67a89118f3b74f950c18db0705f90b
parent7407b82b8be186d6bea2706bd74578ede471f6ec

std.Io.Reader: Add clarification to streamDelimiterEnding doc comment

1 files changed, 4 insertions(+), 2 deletions(-)

lib/std/Io/Reader.zig+4-2
...@@ -957,8 +957,8 @@ pub fn peekDelimiterExclusive(r: *Reader, delimiter: u8) DelimiterError![]u8 {...@@ -957,8 +957,8 @@ pub fn peekDelimiterExclusive(r: *Reader, delimiter: u8) DelimiterError![]u8 {
957 return result[0 .. result.len - 1];957 return result[0 .. result.len - 1];
958}958}
959959
960/// Appends to `w` contents by reading from the stream until `delimiter` is960/// Appends to `w` contents by reading from the stream until `delimiter` is found.
961/// found. Does not write the delimiter itself.961/// Does not write the delimiter itself.
962///962///
963/// Does not discard the delimiter from the `Reader`.963/// Does not discard the delimiter from the `Reader`.
964///964///
...@@ -983,6 +983,8 @@ pub fn streamDelimiter(r: *Reader, w: *Writer, delimiter: u8) StreamError!usize...@@ -983,6 +983,8 @@ pub fn streamDelimiter(r: *Reader, w: *Writer, delimiter: u8) StreamError!usize
983/// Appends to `w` contents by reading from the stream until `delimiter` is found.983/// Appends to `w` contents by reading from the stream until `delimiter` is found.
984/// Does not write the delimiter itself.984/// Does not write the delimiter itself.
985///985///
986/// Does not discard the delimiter from the `Reader`.
987///
986/// Returns number of bytes streamed, which may be zero. If the stream reaches988/// Returns number of bytes streamed, which may be zero. If the stream reaches
987/// the end, the reader buffer will be empty when this function returns.989/// the end, the reader buffer will be empty when this function returns.
988/// Otherwise, it will have at least one byte buffered, starting with the990/// Otherwise, it will have at least one byte buffered, starting with the