Libraries
Class CloseableReader
Class summary
| close --clear-buffered/bool= -> none | Closes this reader. |
|---|---|
| is-closed -> bool | Whether this reader is closed. |
| operator == other/any -> bool | Whether this object is equal to the other. |
| stringify -> string | Stringifies this object. |
| clear -> none | Clears any buffered data. |
| ensure-buffered n/int -> none | Ensures that at least n bytes are buffered. |
| try-ensure-buffered n/int -> bool | Attempts to buffer at least n bytes. |
| is-buffered n/int -> bool | Whether n bytes are available in the internal buffer. |
| buffer-all -> none | Buffers all the remaining data of this reader. |
| buffered-size -> int | The amount of buffered data. |
| processed -> int | The number of bytes that have been produced by this reader so far. |
| skip n/int -> none | Skips over the next n bytes. |
| skip-up-to delimiter/int --to/int= --throw-if-absent/bool= -> int | Skips all bytes up to and including the given delimiter. |
| peek-byte n/int= -> int | Gets the n th byte from our current position. |
| peek-bytes n/int -> ByteArray | Gets the n next bytes. |
| read-all -> ByteArray | Reads the rest of the data and returns it. |
| drain -> none | Drains the reader without buffering or returning the data. |
| index-of byte/int --to/int= --throw-if-absent/bool= -> int | Searches forwards for the byte. |
| read --max-size/int= -> ByteArray | Reads from the reader. |
| read-string n/int -> string | Reads the first n bytes as a string. |
| read-string --max-size/int= -> string | Reads at most max-size bytes as a string. |
| read-byte -> int | Reads the first byte. |
| read-bytes n/int -> ByteArray | Reads the first n bytes from the reader. |
| peek-string n/int -> string | Gets the first n bytes and returns them as string. |
| read-line --keep-newline/bool= -> string | Reads a line as a string. |
| read-lines --keep-newlines/bool= -> List | Reads the remaining data as lines. |
| do --lines/True --keep-newlines/bool= [block] -> none | Calls the given block for each remaining line. |
| read-string-up-to delimiter/int -> string | Reads the string before the delimiter. |
| read-bytes-up-to delimiter/int -> ByteArray | Reads the bytes before the delimiter. |
| unget value/ByteArray --hand-over/bool= -> none | Prepends the values in the value byte-array. |
| little-endian -> EndianReader | Provides endian-aware functions to read from this instance. |
| big-endian -> EndianReader | Provides endian-aware functions to read from this instance. |
| content-size -> int | The total number of bytes that this reader can produce. |
Methods
Provides endian-aware functions to read from this instance.
The big-endian byte order reads higher-order (big) bytes first. For example, if the source of the read operation is a byte array, then first byte read (from position 0) is the most significant byte of the number that is read.
Examples
import io
main:
reader := io.Reader #[0x12, 0x34, 0x56, 0x78]
number := reader.big-endian.read-int32
// The most significant byte 0x12 was at index 0.
print "0x$(%x number)" // => 0x12345678
Buffers all the remaining data of this reader.
The amount of buffered data.
This function does not read any new data from the resource, but only uses the buffered data.
Closes this reader.
Reading from the reader after this method has been called is allowed and returns the buffered data and then null.
If clear-buffered is true, then the buffered data is dropped and reading from the reader after this method has been called returns null.
The total number of bytes that this reader can produce.
This value is not updated when data is consumed.
If the reader does not know the size, returns null.
Calls the given block for each remaining line.
Drains the reader without buffering or returning the data.
Ensures that at least n bytes are buffered.
Errors
Searches forwards for the byte.
Consumes no bytes.
If to is specified the search is limited to the given range.
Returns the index of the first occurrence of the byte.
If throw-if-absent is true and byte is not in the remaining data throws.
Returns -1 if throw-if-absent is false (the default) and the byte is not in the remaining data.
Whether n bytes are available in the internal buffer.
This function does not read any new data from the resource, but only uses the buffered data.
Provides endian-aware functions to read from this instance.
The little-endian byte order reads lower-order ("little") bytes first. For example, if the source of the read operation is a byte array, then first byte read (from position 0) is the least significant byte of the number that is read.
Examples
import io
main:
reader := io.Reader #[0x78, 0x56, 0x34, 0x12]
number := reader.little-endian.read-int32
// The least significant byte 0x78 was at index 0.
print "0x$(%x number)" // => 0x12345678
Whether this object is equal to the other.
Inheritance
Classes overwrite this operator to get an equality specific to their needs. Equality operators often compare the type and field contents. For example:
class Pin:
number/int
constructor .number:
operator == other:
if other is not Pin: return false
return number == other.number
A class doesn't have to follow the above format, but it must keep the operator in sync with any
hash-code method. That is, if a class has a hash-code member, then the equality and hash-code must agree. If two instances are equal (a == b), then their hash codes must also be equal (a.hash-code == b.hash-code).Gets the n th byte from our current position.
Does not consume the data, but caches it in this instance.
If enough data is already cached simply returns the byte without requesting more data.
Errors
At least n + 1 bytes must be available.
Gets the n next bytes.
Does not consume the data, but caches it in this instance.
If enough data is already cached simply returns the bytes without requesting more data.
Errors
At least n bytes must be available.
Gets the first n bytes and returns them as string.
Does not consume the data, but caches it in this instance.
Errors
The peeked bytes must be convertible to a UTF8 string.
At least n bytes must be available.
Examples
class MyReader implements Reader:
read -> ByteArray?: return "hellø".to-byte-array
main:
reader := BufferedReader MyReader
print
reader.peek-string 6 // >> Hellø
print
reader.peek-string 5 // >> Error!
Reads from the reader.
If data has been buffered returns the buffered data first. Otherwise, attempts to read new data from the resource.
The read bytes are consumed.
If max-size is specified the returned byte array will never be larger than that size, but it may be smaller, even if there is more data available from the underlying resource. Use read-bytes to read exactly n bytes.
Returns null if no more data is available.
Reads the first byte.
The read byte is consumed.
Errors
At least 1 byte must be available.
Reads the first n bytes from the reader.
The read bytes are consumed.
If you want to read either n bytes, if they are available, or the maximum number of available bytes otherwise, use the following code:
read-exactly-or-drain reader/BufferedReader n/int -> ByteArray?:
if can-ensure n: return reader.read-bytes n
reader.buffer-all
if reader.buffered == 0: return null
return reader.read-bytes reader.buffered
Reads the bytes before the delimiter.
The read bytes and the delimiter are consumed.
The returned bytes do not include the delimiter.
Errors
The delimiter must be available.
Reads a line as a string.
If keep-newline is true, the returned string includes the newline character.
If keep-newline is false (the default), trims the trailing '\r\n' or '\n'. This method removes a '\r' even if the platform is not Windows. If the '\r' needs to be preserved, set keep-newline to true and remove the trailing '\n' manually.
If the input ends with a newline, then all further reads return null.
If the input ends without a newline, then the last line is returned without any newline character (even if keep-newline) is true, and all further reads return null.
Returns null if no more data is available.
Reads the remaining data as lines.
Reads the first n bytes as a string.
The read bytes are consumed.
Errors
The read bytes must be convertible to a UTF8 string.
At least n bytes must be available.
Examples
class MyReader implements Reader:
read -> ByteArray?: return "hellø".to-byte-array
main:
reader := BufferedReader MyReader
print
reader.read-string 6 // >> Hellø
print
reader.read-string 5 // >> Error!
Reads at most max-size bytes as a string.
The read bytes are consumed.
Note that this method is different from read followed by ByteArray.to-string as it ensures that the data is split into valid UTF-8 chunks.
If max-size is specified the returned string will never be larger than that size (in bytes), but it may be smaller, even if there is more data available from the underlying reader.
Returns null if the stream has ended.
Errors
The read bytes must be convertible to a legal UTF8 string, but this method will read a number of bytes such that legal UTF-8 characters are not chopped up.
May throw an end-of-stream exception if the stream ends in the middle of a malformed UTF-8 character.
Instead of returning a zero length string it throws an exception. This can happen if max-size is less than 4 bytes and the next thing is a UTF-8 character that is coded in more bytes than were requested. This also means max-size should never be zero.
Reads the string before the delimiter.
The read bytes and the delimiter are consumed.
The returned string does not include the delimiter.
Errors
The delimiter must be available.
Skips all bytes up to and including the given delimiter.
Returns the number of bytes skipped including the delimiter.
If to is given, then the search is limited to the given range.
If throw-if-absent is true and the delimiter is not in the remaining data, throws.
If throw-if-absent is false (the default) and the delimiter is not in the remaining data, skips all remaining data.
Stringifies this object.
Inheritance
Objects that need a human-friendly string representation should overwrite this method. The default string is based on the internal class-ID.
Attempts to buffer at least n bytes.
Returns whether it was able to.
Prepends the values in the value byte-array.
These will be the first bytes to be read in subsequent read operations.
If hand-over is true, then this instance takes ownership of value. In this case, its content must not be modified after being given to this method.