suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add notes about reading entire ports

Browse Source
This commit is contained in:
Jon Rafkind 2010-10-27 12:06:21 -06:00
parent b8ad3ad1cb
commit 5633895cf0
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
collects/scribblings/reference/string-input.scrbl
View File

@ -74,6 +74,8 @@ Like @scheme[read-line], but reads bytes and produces a byte string.}
[in input-port? (current-input-port)])
(or/c string? eof-object?)]{
@margin-note{To read an entire port as a string use @scheme[port->string].}
Returns a string containing the next @scheme[amt] characters from
@scheme[in].
@ -94,6 +96,7 @@ encountering an error, the characters are dropped.}
@defproc[(read-bytes [amt exact-nonnegative-integer?]
[in input-port? (current-input-port)])
(or/c bytes? eof-object?)]{
@margin-note{To read an entire port as bytes use @scheme[port->bytes].}
Like @scheme[read-string], but reads bytes and produces a byte string.}
@defproc[(read-string! [str (and/c string? (not/c immutable?))]