|
JUCE
|
|
JUCE
|
An input stream that reads from a local file. More...
Inherits InputStream.
Public Member Functions | |
| FileInputStream (const File &fileToRead) | |
| Creates a FileInputStream. | |
| ~FileInputStream () | |
| Destructor. | |
| const File & | getFile () const noexcept |
| Returns the file that this stream is reading from. | |
| const Result & | getStatus () const noexcept |
| Returns the status of the file stream. | |
| bool | failedToOpen () const noexcept |
| Returns true if the stream couldn't be opened for some reason. | |
| bool | openedOk () const noexcept |
| Returns true if the stream opened without problems. | |
| int64 | getTotalLength () |
| Returns the total number of bytes available for reading in this stream. | |
| int | read (void *destBuffer, int maxBytesToRead) |
| Reads some data from the stream into a memory buffer. | |
| bool | isExhausted () |
| Returns true if the stream has no more data to read. | |
| int64 | getPosition () |
| Returns the offset of the next byte that will be read from the stream. | |
| bool | setPosition (int64 pos) |
| Tries to move the current read position of the stream. | |
An input stream that reads from a local file.
| FileInputStream::FileInputStream | ( | const File & | fileToRead | ) | [explicit] |
Creates a FileInputStream.
| fileToRead | the file to read from - if the file can't be accessed for some reason, then the stream will just contain no data |
Destructor.
| const File& FileInputStream::getFile | ( | ) | const |
Returns the file that this stream is reading from.
| const Result& FileInputStream::getStatus | ( | ) | const |
Returns the status of the file stream.
The result will be ok if the file opened successfully. If an error occurs while opening or reading from the file, this will contain an error message.
| bool FileInputStream::failedToOpen | ( | ) | const |
Returns true if the stream couldn't be opened for some reason.
| bool FileInputStream::openedOk | ( | ) | const |
Returns true if the stream opened without problems.
| int64 FileInputStream::getTotalLength | ( | ) | [virtual] |
Returns the total number of bytes available for reading in this stream.
Note that this is the number of bytes available from the start of the stream, not from the current position.
If the size of the stream isn't actually known, this will return -1.
Implements InputStream.
| int FileInputStream::read | ( | void * | destBuffer, |
| int | maxBytesToRead | ||
| ) | [virtual] |
Reads some data from the stream into a memory buffer.
This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).
| destBuffer | the destination buffer for the data. This must not be null. |
| maxBytesToRead | the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative. |
Implements InputStream.
| bool FileInputStream::isExhausted | ( | ) | [virtual] |
Returns true if the stream has no more data to read.
Implements InputStream.
| int64 FileInputStream::getPosition | ( | ) | [virtual] |
Returns the offset of the next byte that will be read from the stream.
Implements InputStream.
| bool FileInputStream::setPosition | ( | int64 | newPosition | ) | [virtual] |
Tries to move the current read position of the stream.
The position is an absolute number of bytes from the stream's start.
Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.
Implements InputStream.
