hare

commit c6d012f63aebeec0c173d7da30876816a42e6262
parent e54168dbe319e1b636bc191d3a341811689ef5a2
Author: Sebastian <sebastian@sebsite.pw>
Date:   Thu,  5 Jan 2023 18:03:09 -0500

io: add note about infinite handles in drain docs

Signed-off-by: Sebastian <sebastian@sebsite.pw>

Diffstat:
M
io/drain.ha
 | 
1
+

1 file changed, 1 insertion(+), 0 deletions(-)
diff --git a/io/drain.ha b/io/drain.ha
@@ -4,6 +4,7 @@
 // (c) 2021 Ember Sawady <ecs@d2evs.net>
 
 // Reads an entire stream into a []u8. The caller must free the return value.
+// Note that this function will never return if the handle is infinite.
 export fn drain(in: handle) ([]u8 | error) = {
 	let sink: []u8 = [];
 	static let buf: [4096]u8 = [0...];