Fix documentation of pipe().

This commit is contained in:
Sönke Ludwig 2020-03-14 18:37:54 +01:00
parent 6041347405
commit 5010085340

View file

@ -27,9 +27,9 @@ public import eventcore.driver : IOMode;
/** Pipes an InputStream directly into this OutputStream.
The number of bytes written is either the whole input stream when `nbytes == 0`, or exactly
`nbytes` for `nbytes > 0`. If the input stream contains less than `nbytes` of data, an
exception is thrown.
The number of bytes written is either the whole input stream when
`nbytes == ulong.max`, or exactly `nbytes` for `nbytes < ulong.max`. If the
input stream contains less than `nbytes` of data, an exception is thrown.
Returns:
The actual number of bytes written is returned. If `nbytes` is given