Interface InputStream

Interface for all classes implementing readable streams.

Properties

Property name Type Description
empty bool Returns true iff the end of the stream has been reached
leastSize ulong Returns the maximum number of bytes that are known to remain in this stream until the end is reached. After leastSize() bytes have been read, the stream will either have reached EOS and empty() returns true, or leastSize() returns again a number > 0.
dataAvailableForRead bool Queries if there is data available for immediate, non-blocking read.

Methods

Method name Description
peek Returns a temporary reference to the data that is currently buffered, typically has the size leastSize() or 0 if dataAvailableForRead() returns false.
read Fills the preallocated array 'bytes' with data from the stream.

Authors

Sönke Ludwig

Copyright

© 2012 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.