Stream := Object clone.
A Stream object stores a stream which can be written to or read
from. Some streams are unidirectional and are only designated for
reading or writing but not both. The direction of a stream can be
checked with in? and out?.
Stream toString := "String".
Stream dumpHandler := ~DUMP.
Stream in?.Returns whether the stream is designated for input.
Stream out?.Returns whether the stream is designated for output.
Stream puts (str).Sends str, which must be a string, to the stream. The stream must be
designated for output, or an IOError will be raised.
Stream putln (str).Sends str, which must be a string, to the stream, followed by a
newline. The stream must be designated for output, or an IOError
will be raised.
Stream print (obj).Sends obj to the stream. toString will be called on obj before
it is sent to the stream. The stream must be designated for output, or
an IOError will be raised.
Stream println (obj).Sends obj to the stream, followed by a newline. toString will be
called on obj before it is sent to the stream. The stream must be
designated for output, or an IOError will be raised.
Stream printf (obj, args...).Calls obj (a proc-like object) with args... as arguments. The
resulting string is sent to the stream. The stream must be designated
for output, or an IOError will be raised. This method works on any
proc-like object but is most often used
with FormatString.
Stream readln.Reads one full line of input from the stream and returns it, as a
string. The newline is always omitted from the returned string. If the
stream has reached its end (eof?), the empty string is returned. If
the stream has not reached its end but is blocking, then this function
may block. If the stream is not designated for input, then an
IOError will be raised.
Stream read.Reads one character of input from the stream and returns it, as a
string. If the stream has reached its end (eof?), the empty string
is returned. If the stream has not reached its end but is blocking,
then this function may block. If the stream is not designated for
input, then an IOError will be raised.
Note carefully that, when calling this on the standard input stream
$stdin in the REPL, the REPL shares the same input stream. So if
$stdin read is called and more than one character is entered, the
remaining characters will be treated as a line of Latitude code by the
REPL.
Stream eof?.Returns whether or not the stream has reached its end.
Stream close.Closes the stream. Any further operations other than subsequent
close calls on the stream will have an undefined result. close is
idempotent, so that calling it on a closed stream will have no
effect. Streams should always be closed explicitly and will not be
closed by the VM.
Stream closeAfter (mthd).Calls the method mthd. The caller of this method will be the stream
object self. After the method terminates (or is exited for any
reason, such as a continuation jump), the stream will be closed with
close. Note that closeAfter uses the VM thunk system internally,
so Kernel kill will still bypass this method’s protection.
Stream flush.Flushes the stream, forcing any buffered output to be written to the
stream’s target. If the stream is not designated for output, an
IOError will be raised.
Stream dump (obj).Prints all slots on the object to the stream. For each slot (obtained
via Kernel keys), the slot’s name and value will be printed, as well
as a signaling character (!) if the slot has protection.
It is possible for objects to override this behavior. If an object has
a slot with the generated name Stream dumpHandler defined on it,
then that slot should contain a dictionary. For each slot on the
object whose name is a valid key in the dumpHandler dictionary, the
value in the dictionary will be called instead of printing the
standard line. The call will be made (via the call method) with the
stream object self as the only argument.
Stream open (filename, mode).Returns a new Stream object which points to the file with name
filename. The stream will be opened with access and mode modifiers
depending on the mode argument, which should be a string.
| String | Result |
|---|---|
"r" |
Read-only |
"w" |
Write-only |
"rb" |
Read-only (binary) |
"wb" |
Write-only (binary) |
Note that some operating systems may disregard the binary flag.
Stream exists? (filename).Returns whether or not a file with the given name exists.
Stream null.Returns a special input-output stream object which ignores anything
written to it and returns "" whenever it is read from.
[up]
[prev - The Stack Frame Object]
[next - The String Object]