Interface FileStream

Accesses the contents of a file as a stream.

Inherits from

Properties

Name Type Description
isOpen [get] bool Determines if the file stream is still open
path [get] Path The path of the file.
dataAvailableForRead [get] bool Queries if there is data available for immediate, non-blocking read.
empty [get] bool Returns true iff the end of the input stream has been reached.
leastSize [get] 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.
readable [get] bool Determines if this stream is readable.
size [get] ulong Returns the total size of the file.
writable [get] bool Determines if this stream is writable.

Methods

Name Description
close Closes the file handle.
finalize Flushes and finalizes the stream.
flush Flushes the stream and makes sure that all data is being written to the output device.
peek Returns a temporary reference to the data that is currently buffered, typically has the size leastSize() or 0 if dataAvailableForRead() returns false.
put These methods provide an output range interface.
read Fills the preallocated array 'bytes' with data from the stream.
seek Seeks to a specific position in the file if supported by the stream.
tell Returns the current offset of the file pointer
write Writes an array of bytes to the stream.
write Writes an array of chars to the stream.
write Pipes an InputStream directly into this OutputStream.

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.