stream

type stream

Base type of readable and writable byte streams.

meth (Stream: stream):close: nil

Closes Stream. This method should be overridden for streams defined in Minilang.

meth (Source: stream):copy(Destination: stream): integer

Copies the remaining bytes from Source to Destination.

meth (Source: stream):copy(Destination: stream, Count: integer): integer

Copies upto Count bytes from Source to Destination.

meth (Stream: stream):flush

Flushes Stream. This method should be overridden for streams defined in Minilang.

meth (Arg₁: stream):parse(Arg₂: function)

TBD

meth (Stream: stream):read: string | nil

Equivalent to Stream:readi(SIZE_MAX, 'n').

meth (Stream: stream):read(Buffer: buffer): integer

Reads bytes from Stream into Buffer to Stream. This method should be overridden for streams defined in Minilang.

meth (Stream: stream):read(Count: integer): address | nil

Returns the next text from Stream upto Count characters. Returns nil if Stream is empty.

meth (Stream: stream):read(Type: type, Count: integer): Type | nil

Returns the next text from Stream upto Count characters. Returns nil if Stream is empty.

meth (Stream: stream):readi(Delimiters: string): string | nil

Returns the next text from Stream, upto and including any character in Delimiters. Returns nil if Stream is empty.

meth (Stream: stream):readi(Delimiters: string, Count: integer): string | nil

Returns the next text from Stream, upto and including any character in Delimiters or Count characters, whichever comes first. Returns nil if Stream is empty.

meth (Stream: stream):readi(Type: type, Delimiters: string): Type | nil

Returns the next text from Stream, upto and including any character in Delimiters. Returns nil if Stream is empty.

meth (Stream: stream):readi(Type: type, Delimiters: string, Count: integer): Type | nil

Returns the next text from Stream, upto and including any character in Delimiters or Count characters, whichever comes first. Returns nil if Stream is empty.

meth (Stream: stream):reads(Count: integer): string | nil

Returns the next text from Stream upto Count characters. Returns nil if Stream is empty.

meth (Stream: stream):readx(Delimiters: string): string | nil

Returns the next text from Stream, upto but excluding any character in Delimiters. Returns nil if Stream is empty.

meth (Stream: stream):readx(Delimiters: string, Count: integer): string | nil

Returns the next text from Stream, upto but excluding any character in Delimiters or Count characters, whichever comes first. Returns nil if Stream is empty.

meth (Stream: stream):readx(Type: type, Delimiters: string): Type | nil

Returns the next text from Stream, upto but excluding any character in Delimiters. Returns nil if Stream is empty.

meth (Stream: stream):readx(Type: type, Delimiters: string, Count: integer): Type | nil

Returns the next text from Stream, upto but excluding any character in Delimiters or Count characters, whichever comes first. Returns nil if Stream is empty.

meth (Stream: stream):rest: string | nil

Returns the remainder of Stream or nil if Stream is empty.

meth (Stream: stream):rest(Type: type): Type | nil

Returns the remainder of Stream or nil if Stream is empty.

meth (Stream: stream):seek(Offset: integer, Mode: stream::seek): integer

Sets the position for the next read or write in Stream to Offset using Mode. This method should be overridden for streams defined in Minilang.

meth (Stream: stream):tell: integer

Gets the position for the next read or write in Stream. This method should be overridden for streams defined in Minilang.

meth (Stream: stream):write(Address: address): integer

Writes the bytes at Address to Stream. This method should be overridden for streams defined in Minilang.

meth (Stream: stream):write(Value₁, : any, ...): integer

Writes each Valueᵢ in turn to Stream.

type stream::buffered < stream

A stream that buffers reads and writes from another stream.

meth stream::buffered(Stream: stream, Size: integer): stream::buffered

Returns a new stream that buffers reads and writes from Stream.

meth (Stream: stream::buffered):flush

Writes any bytes in the buffer.

type stream::fd < stream

A file-descriptor based stream.

meth (Stream: stream::fd):read(Dest: buffer): integer

Reads from Stream into Dest returning the actual number of bytes read.

meth (Stream: stream::fd):write(Source: address): integer

Writes from Source to Stream returning the actual number of bytes written.

type stream::parser < function, sequence

TBD

type stream::seek < enum

• ::Set

• ::Cur

• ::End