Reads a single character from
in—
which may involve reading several bytes to UTF-8-decode them into a character (see
Ports); a minimal number of bytes are read/
peeked to perform the decoding. If no bytes are available before an end-of-file, then
eofis returned.
Examples:
Reads a single byte from
in. If no bytes are available before an end-of-file, then
eofis returned.
Examples:
'(97 97)
'(206 187 #<eof>)
Returns a string containing the next line of bytes from in.
Characters are read from in until a line separator or an end-of-file is read. The line separator is not included in the result string (but it is removed from the port’s stream). If no characters are read before an end-of-file is encountered, eof is returned.
The mode argument determines the line separator(s). It must be one of the following symbols:
'return-linefeed breaks lines on return-linefeed combinations. If a return character is not followed by a linefeed character, it is included in the result string; similarly, a linefeed that is not preceded by a return is included in the result string.
'any breaks lines on any of a return character, linefeed character, or return-linefeed combination. If a return character is followed by a linefeed character, the two are treated as a combination.
'any-one breaks lines on either a return or linefeed character, without recognizing return-linefeed combinations.
Return and linefeed characters are detected after the conversions that are automatically performed when reading a file in text mode. For example, reading a file in text mode on Windows automatically changes return-linefeed combinations to a linefeed. Thus, when a file is opened in text mode, 'linefeed is usually the appropriate read-line mode.
Examples:
"x"
"x\ny\n"
"x"
"x"
'("x" "y")
'("x" "")
Like
read-line, but reads bytes and produces a byte string.
Returns a string containing the next amt characters from in.
If amt is 0, then the empty string is returned. Otherwise, if fewer than amt characters are available before an end-of-file is encountered, then the returned string will contain only those characters before the end-of-file; that is, the returned string’s length will be less than amt. (A temporary string of size amt is allocated while reading the input, even if the size of the result is less than amt characters.) If no characters are available before an end-of-file, then eof is returned.
If an error occurs during reading, some characters may be lost; that is, if read-string successfully reads some characters before encountering an error, the characters are dropped.
Example:
Like
read-string, but reads bytes and produces a byte string.
Example:
Reads characters from
inlike
read-string, but puts them into
strstarting from index
start-pos(inclusive) up to
end-pos(exclusive). Like
substring, the
exn:fail:contractexception is raised if
start-posor
end-posis out-of-range for
str.
If the difference between start-pos and end-pos is 0, then 0 is returned and str is not modified. If no bytes are available before an end-of-file, then eof is returned. Otherwise, the return value is the number of characters read. If m characters are read and m<end-pos-start-pos, then str is not modified at indices start-pos+m through end-pos.
Example:
"__________"
"__cket____"
"Racket____"
Like
read-string!, but reads bytes, puts them into a byte string, and returns the number of bytes read.
Example:
#"__________"
#"__cket____"
#"Racket____"
Like
read-bytes!, but returns without blocking after having read the immediately available bytes, and it may return a procedure for a “special” result. The
read-bytes-avail!procedure blocks only if no bytes (or specials) are yet available. Also unlike
read-bytes!,
read-bytes-avail!never drops bytes; if
read-bytes-avail!successfully reads some bytes and then encounters an error, it suppresses the error (treating it roughly like an end-of-file) and returns the read bytes. (The error will be triggered by future reads.) If an error is encountered before any bytes have been read, an exception is raised.
When in produces a special value, as described in Custom Ports, the result is a procedure of four arguments. The four arguments correspond to the location of the special value within the port, as described in Custom Ports. If the procedure is called more than once with valid arguments, the exn:fail:contract exception is raised. If read-bytes-avail! returns a special-producing procedure, then it does not place characters in bstr. Similarly, read-bytes-avail! places only as many bytes into bstr as are available before a special value in the port’s stream.
Like
read-bytes-avail!, but returns
0immediately if no bytes (or specials) are available for reading and the end-of-file is not reached.
Similar to
read-string, except that the returned characters are
peeked: preserved in the port for future reads and
peeks. (More precisely, undecoded bytes are left for future reads and peeks.) The
skip-bytes-amtargument indicates a number of bytes (
notcharacters) in the input stream to skip before collecting characters to return; thus, in total, the next
skip-bytes-amtbytes plus
amtcharacters are inspected.
For most kinds of ports, inspecting skip-bytes-amt bytes and amt characters requires at least skip-bytes-amt+amt bytes of memory overhead associated with the port, at least until the bytes/characters are read. No such overhead is required when peeking into a string port (see String Ports), a pipe port (see Pipes), or a custom port with a specific peek procedure (depending on how the peek procedure is implemented; see Custom Ports).
If a port produces eof mid-stream, attempts to skip beyond the eof for a peek always produce eof until the eof is read.
Like
peek-string!, but
peeksbytes, puts them into a byte string, and returns the number of bytes read.
To peek, peek-bytes-avail! blocks until finding an end-of-file, at least one byte (or special) past the skipped bytes, or until a non-#f progress becomes ready. Furthermore, if progress is ready before bytes are peeked, no bytes are peeked or skipped, and progress may cut short the skipping process if it becomes available during the peek attempt. Furthermore, progress is checked even before determining whether the port is still open.
The result of peek-bytes-avail! is 0 only
when start-pos is equal to end-pos, or
when progress becomes ready before bytes are peeked.
Like
read-bytes-avail!*, but for
peeking, and with
skip-bytes-amtand
progressarguments like
peek-bytes-avail!. Since this procedure never blocks, it may return before even
skip-bytes-amtbytes are available from the port.
Like
read-char, but if the input port returns a
specialvalue (through a value-generating procedure in a custom port, where
source-nameis provided to the procedure; see
Custom Portsand
Special Commentsfor details), then the result of applying
special-wrapto the
specialvalue is returned. A
#fvalue for
special-wrapis treated the same as the identity function.
Changed in version 6.8.0.2 of package base: Added the special-wrap and source-name arguments.
Changed in version 6.8.0.2 of package base: Added the special-wrap and source-name arguments.
Like
read-char, but
peeksinstead of reading, and skips
skip-bytes-amtbytes (not characters) at the start of the port.
Like
peek-char, but if the input port returns a non-byte value after
skip-bytes-amtbyte positions, then the result depends on
special-wrap:
If special-wrap is #f, then the special value is returned (as for read-char-or-special).
If special-wrap is a procedure, then it is applied the special value to produce the result (as for read-char-or-special).
If special-wrap is 'special, then 'special is returned in place of the special value—without calling the special-value procedure that is returned by the input-port implementation.
Changed in version 6.8.0.2 of package base: Added the special-wrap and source-name arguments.
Changed in version 6.90.0.16: Added 'special as an option for special-wrap.
Changed in version 6.8.0.2 of package base: Added the special-wrap and source-name arguments.
Changed in version 6.90.0.16: Added 'special as an option for special-wrap.
Attempts to
commitas read the first
amtpreviously
peeked bytes, non-byte specials, and
eofs from
in, or the first
eofor special value peeked from
in. Mid-stream
eofs can be committed, but an
eofwhen the port is exhausted does not necessarily commit, since it does not correspond to data in the stream.
The read commits only if progress does not become ready first (i.e., if no other process reads from in first), and only if evt is chosen by a sync within port-commit-peeked (in which case the event result is ignored); the evt must be either a channel-put event, channel, semaphore, semaphore-peek event, always event, or never event. Suspending the thread that calls port-commit-peeked may or may not prevent the commit from proceeding.
The result from port-commit-peeked is #t if data has been committed, and #f otherwise.
If no data has been peeked from in and progress is not ready, then exn:fail:contract exception is raised. If fewer than amt items have been peeked at the current start of in’s stream, then only the peeked items are committed as read. If in’s stream currently starts at an eof or a non-byte special value, then only the eof or special value is committed as read.
If progress is not a result of port-progress-evt applied to in, then exn:fail:contract exception is raised.
The byte-ready? and char-ready? functions are appropriate for relatively few applications, because ports are meant to support streaming data among concurrent producers and consumers; the fact that a byte or character is not ready in some instant does not necessarily mean that the producer is finished supplying data. (Also, if a port has multiple consumers, data might get consumed between the time that a given process uses byte-ready? to poll the port and the time that it reads data from the port.) Using byte-ready? makes sense if you are implementing your own scheduler or if you know that the port’s implementation and use are particularly constrained.
Returns
#tif
(read-char in)would not block (at the time that
char-ready?was called, at least). Depending on the initial bytes of the stream, multiple bytes may be needed to form a UTF-8 encoding.
See byte-ready? for a note on how byte-ready? and char-ready? are rarely the right choice.
With one argument, returns #t is v is a progress evt for some input port, #f otherwise.
With two arguments, returns #t if evt is a progress event for in, #f otherwise.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4