Class MemoryStream

Provides a random access stream interface for accessing an array of bytes.

Inherits from

Properties

Property name Type Description
peekWindow - Controls the maximum size of the array returned by peek().
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.
size ulong Returns the total size of the file.
readable bool Determines if this stream is readable.
writable bool Determines if this stream is writable.

Methods

Method name Description
this Creates a new stream with the given data array as its contents.
seek Seeks to a specific position in the file if supported by the stream.
tell Returns the current offset of the file pointer
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.
write Writes an array of bytes to the stream.
flush Flushes the stream and makes sure that all data is being written to the output device.
finalize Flushes and finalizes the stream.
write Pipes an InputStream directly into this OutputStream.
write [inherited] Writes an array of chars to the stream.
put [inherited] These methods provide an output range interface.

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.