From 4f5fa959aa80ce39828b8bf45098029ce818fda2 Mon Sep 17 00:00:00 2001 From: Andrew Kelley Date: Mon, 14 Jul 2025 21:01:40 -0700 Subject: [PATCH] std.Io.Reader.streamDelimiterEnding docs clarification --- lib/std/Io/Reader.zig | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/std/Io/Reader.zig b/lib/std/Io/Reader.zig index c8bd0f3000..9c3d14fe55 100644 --- a/lib/std/Io/Reader.zig +++ b/lib/std/Io/Reader.zig @@ -859,8 +859,10 @@ pub fn streamDelimiter(r: *Reader, w: *Writer, delimiter: u8) StreamError!usize /// Appends to `w` contents by reading from the stream until `delimiter` is found. /// Does not write the delimiter itself. /// -/// Returns number of bytes streamed, which may be zero. End of stream can be -/// detected by checking if the next byte in the stream is the delimiter. +/// Returns number of bytes streamed, which may be zero. If the stream reaches +/// the end, the reader buffer will be empty when this function returns. +/// Otherwise, it will have at least one byte buffered, starting with the +/// delimiter. /// /// Asserts buffer capacity of at least one. This function performs better with /// larger buffers.