hare

commit 7ae6b0dfbe7000bd87aa0835a8658328b4f2677d
parent 84d3720a46af582bfe4ebb182dfeda29c0cc5ff3
Author: Drew DeVault <sir@cmpwn.com>
Date:   Wed, 12 May 2021 18:23:07 -1000

io::limit: clarify close behavior

Diffstat:
M
io/limit.ha
 | 
6
++++--

1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/io/limit.ha b/io/limit.ha
@@ -20,7 +20,8 @@ fn limited_stream_new(source: *stream, limit: size) *limited_stream = {
 };
 
 // Create an overlay stream that only allows a limited amount of bytes to be
-// read from the underlying stream.
+// read from the underlying stream. Closing the limit stream does not close the
+// underlying stream.
 export fn limitreader(source: *stream, limit: size) *stream = {
 	let stream = limited_stream_new(source, limit);
 	stream.stream.reader = &limited_read;
@@ -28,7 +29,8 @@ export fn limitreader(source: *stream, limit: size) *stream = {
 };
 
 // Create an overlay stream that only allows a limited amount of bytes to be
-// written to the underlying stream.
+// written to the underlying stream. Closing the limit stream does not close the
+// underlying stream.
 export fn limitwriter(source: *stream, limit: size) *stream = {
 	let stream = limited_stream_new(source, limit);
 	stream.stream.writer = &limited_write;