On this page:
bad?
read
seek
skip
tell
Version: 4.1

editor-stream-in-base% : class?

  superclass: object%

An editor-stream-in-base% object is used by an editor-stream-in% object to perform low-level reading of data.

The editor-stream-in-base% class is never instantiated directly, but the derived class editor-stream-in-bytes-base% can be instantiated. New derived classes must override all of the methods described in this section.

(send an-editor-stream-in-base bad?)  boolean?

Returns #t if there has been an error reading from the stream, #f otherwise.

(send an-editor-stream-in-base read data)

  exact-nonnegative-integer?

  data : (and/c bytes? (not/c immutable?))

Reads characters to fill the supplied vector. The return value is the number of characters read, which may be less than the number requested if the stream is emptied. If the stream is emptied, the next call to bad? must return #t.

(send an-editor-stream-in-base seek pos)  void?

  pos : exact-nonnegative-integer?

Moves to the specified absolute position in the stream.

(send an-editor-stream-in-base skip n)  void?

  n : exact-nonnegative-integer?

Skips past the next n characters in the stream.

(send an-editor-stream-in-base tell)

  exact-nonnegative-integer?

Returns the current stream position.