vibe.d beta banner
get vibe.d
0.8.1

Asynchronous I/O that doesn’t get in your way, written in D

Interface FileStream

Accesses the contents of a file as a stream.

interface FileStream
  : RandomAccessStream ;

Properties

NameTypeDescription
isOpen[get]boolDetermines if the file stream is still open
path[get]PathThe path of the file.
dataAvailableForRead[get]bool(Scheduled for deprecation) Queries if there is data available for immediate, non-blocking read.
empty[get]boolReturns true iff the end of the input stream has been reached.
leastSize[get]ulong(Scheduled for deprecation) Returns the maximum number of bytes that are known to remain in this stream until the end is reached.
readable[get]boolDetermines if this stream is readable.
size[get]ulongReturns the total size of the file.
writable[get]boolDetermines if this stream is writable.

Methods

NameDescription
closeCloses the file handle.
finalizeFlushes and finalizes the stream.
flushFlushes the stream and makes sure that all data is being written to the output device.
peekReturns a temporary reference to the data that is currently buffered.
readFills the preallocated array 'bytes' with data from the stream.
seekSeeks to a specific position in the file if supported by the stream.
tellReturns the current offset of the file pointer
writeWrites an array of bytes to the stream.
writePipes an InputStream directly into this OutputStream.
Authors

Sönke Ludwig

Copyright

© 2012-2014 RejectedSoftware e.K.

License

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