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

doc: fix contract for read-string! and related

Browse Source 
Closes #3641
This commit is contained in:
Matthew Flatt 2021-01-23 08:04:28 -07:00
parent 3baed0966d
commit 984d2947a4
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pkgs/racket-doc/scribblings/reference/string-input.scrbl
View File

@ -165,7 +165,7 @@ Like @racket[read-string], but reads bytes and produces a byte string.}
[in input-port? (current-input-port)]
[start-pos exact-nonnegative-integer? 0]
[end-pos exact-nonnegative-integer? (string-length str)])
(or/c exact-positive-integer? eof-object?)]{
(or/c exact-nonnegative-integer? eof-object?)]{
Reads characters from @racket[in] like @racket[read-string], but puts
them into @racket[str] starting from index @racket[start-pos]
@ -197,7 +197,7 @@ not modified at indices @math{@racket[start-pos]+m} through
[in input-port? (current-input-port)]
[start-pos exact-nonnegative-integer? 0]
[end-pos exact-nonnegative-integer? (bytes-length bstr)])
(or/c exact-positive-integer? eof-object?)]{
(or/c exact-nonnegative-integer? eof-object?)]{
Like @racket[read-string!], but reads bytes, puts them into a byte
string, and returns the number of bytes read.
@ -216,7 +216,7 @@ string, and returns the number of bytes read.
[in input-port? (current-input-port)]
[start-pos exact-nonnegative-integer? 0]
[end-pos exact-nonnegative-integer? (bytes-length bstr)])
(or/c exact-positive-integer? eof-object? procedure?)]{
(or/c exact-nonnegative-integer? eof-object? procedure?)]{
Like @racket[read-bytes!], but returns without blocking after having
read the immediately available bytes, and it may return a procedure for
@ -301,7 +301,7 @@ Like @racket[peek-string], but @tech{peeks} bytes and produces a byte string.}
[in input-port? (current-input-port)]
[start-pos exact-nonnegative-integer? 0]
[end-pos exact-nonnegative-integer? (string-length str)])
(or/c exact-positive-integer? eof-object?)]{
(or/c exact-nonnegative-integer? eof-object?)]{
Like @racket[read-string!], but for @tech{peek}ing, and with a
@racket[skip-bytes-amt] argument like @racket[peek-string].}
@ -310,7 +310,7 @@ Like @racket[read-string!], but for @tech{peek}ing, and with a
[in input-port? (current-input-port)]
[start-pos exact-nonnegative-integer? 0]
[end-pos exact-nonnegative-integer? (bytes-length bstr)])
(or/c exact-positive-integer? eof-object?)]{
(or/c exact-nonnegative-integer? eof-object?)]{
Like @racket[peek-string!], but @tech{peeks} bytes, puts them into a byte
string, and returns the number of bytes read.}