mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-04-29 06:30:28 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Clarify that buf can be shortened in readln (#7125)

Browse source 
Clarify that buf can be shortened in readln
merged-on-behalf-of: Vladimir Panteleev <CyberShadow@users.noreply.github.com>
This commit is contained in:
Charles McAnany 2019-08-06 13:30:04 -05:00 • committed by The Dlang Bot
parent 225a6afb36
commit 41f28f6270
1 changed files with 3 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
std/stdio.d
View file

@ -1682,13 +1682,14 @@ must copy the previous contents if you wish to retain them.
Params: Params:
buf = Buffer used to store the resulting line data. buf is buf = Buffer used to store the resulting line data. buf is
resized as necessary. enlarged if necessary, then set to the slice exactly containing the line.
terminator = Line terminator (by default, `'\n'`). Use terminator = Line terminator (by default, `'\n'`). Use
$(REF newline, std,ascii) for portability (unless the file was opened in $(REF newline, std,ascii) for portability (unless the file was opened in
text mode). text mode).
Returns: Returns:
0 for end of file, otherwise number of characters read 0 for end of file, otherwise number of characters read.
The return value will always be equal to `buf.length`.
Throws: `StdioException` on I/O error, or `UnicodeException` on Unicode Throws: `StdioException` on I/O error, or `UnicodeException` on Unicode
conversion error. conversion error.