debian-packages/vibe-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix documentation of pipe().

Browse source
This commit is contained in:
Sönke Ludwig 2020-03-14 18:37:54 +01:00
parent 6041347405
commit 5010085340
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
source/vibe/core/stream.d
View file

@ -27,12 +27,12 @@ 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
The actual number of bytes written is returned. If `nbytes` is given
and not equal to `ulong.max`, íts value will be returned.
*/
ulong pipe(InputStream, OutputStream)(InputStream source, OutputStream sink, ulong nbytes)