|
JUCE
|
|
JUCE
|
Allows a block of data and to be accessed as a stream. More...
Inherits InputStream.
Public Member Functions | |
| MemoryInputStream (const void *sourceData, size_t sourceDataSize, bool keepInternalCopyOfData) | |
| Creates a MemoryInputStream. | |
| MemoryInputStream (const MemoryBlock &data, bool keepInternalCopyOfData) | |
| Creates a MemoryInputStream. | |
| ~MemoryInputStream () | |
| Destructor. | |
| 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. | |
| int64 | getTotalLength () |
| Returns the total number of bytes available for reading in this stream. | |
| bool | isExhausted () |
| Returns true if the stream has no more data to read. | |
| int | read (void *destBuffer, int maxBytesToRead) |
| Reads some data from the stream into a memory buffer. | |
Allows a block of data and to be accessed as a stream.
This can either be used to refer to a shared block of memory, or can make its own internal copy of the data when the MemoryInputStream is created.
| MemoryInputStream::MemoryInputStream | ( | const void * | sourceData, |
| size_t | sourceDataSize, | ||
| bool | keepInternalCopyOfData | ||
| ) |
Creates a MemoryInputStream.
| sourceData | the block of data to use as the stream's source |
| sourceDataSize | the number of bytes in the source data block |
| keepInternalCopyOfData | if false, the stream will just keep a pointer to the source data, so this data shouldn't be changed for the lifetime of the stream; if this parameter is true, the stream will make its own copy of the data and use that. |
| MemoryInputStream::MemoryInputStream | ( | const MemoryBlock & | data, |
| bool | keepInternalCopyOfData | ||
| ) |
Creates a MemoryInputStream.
| data | a block of data to use as the stream's source |
| keepInternalCopyOfData | if false, the stream will just keep a reference to the source data, so this data shouldn't be changed for the lifetime of the stream; if this parameter is true, the stream will make its own copy of the data and use that. |
Destructor.
| int64 MemoryInputStream::getPosition | ( | ) | [virtual] |
Returns the offset of the next byte that will be read from the stream.
Implements InputStream.
| bool MemoryInputStream::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.
| int64 MemoryInputStream::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.
| bool MemoryInputStream::isExhausted | ( | ) | [virtual] |
Returns true if the stream has no more data to read.
Implements InputStream.
| int MemoryInputStream::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.
