|
JUCE
|
|
JUCE
|
Writes data to an internal memory buffer, which grows as required. More...
Inherits OutputStream.
Public Member Functions | |
| MemoryOutputStream (size_t initialSize=256) | |
| Creates an empty memory stream ready for writing into. | |
| MemoryOutputStream (MemoryBlock &memoryBlockToWriteTo, bool appendToExistingBlockContent) | |
| Creates a memory stream for writing into into a pre-existing MemoryBlock object. | |
| ~MemoryOutputStream () | |
| Destructor. | |
| const void * | getData () const noexcept |
| Returns a pointer to the data that has been written to the stream. | |
| size_t | getDataSize () const noexcept |
| Returns the number of bytes of data that have been written to the stream. | |
| void | reset () noexcept |
| Resets the stream, clearing any data that has been written to it so far. | |
| void | preallocate (size_t bytesToPreallocate) |
| Increases the internal storage capacity to be able to contain at least the specified amount of data without needing to be resized. | |
| String | toUTF8 () const |
| Returns a String created from the (UTF8) data that has been written to the stream. | |
| String | toString () const |
| Attempts to detect the encoding of the data and convert it to a string. | |
| MemoryBlock | getMemoryBlock () const |
| Returns a copy of the stream's data as a memory block. | |
| void | flush () |
| If the stream is writing to a user-supplied MemoryBlock, this will trim any excess capacity off the block, so that its length matches the amount of actual data that has been written so far. | |
| bool | write (const void *buffer, int howMany) |
| Writes a block of data to the stream. | |
| int64 | getPosition () |
| Returns the stream's current position. | |
| bool | setPosition (int64 newPosition) |
| Tries to move the stream's output position. | |
| int | writeFromInputStream (InputStream &source, int64 maxNumBytesToWrite) |
| Reads data from an input stream and writes it to this stream. | |
| void | writeRepeatedByte (uint8 byte, int numTimesToRepeat) |
| Writes a byte to the output stream a given number of times. | |
Writes data to an internal memory buffer, which grows as required.
The data that was written into the stream can then be accessed later as a contiguous block of memory.
| MemoryOutputStream::MemoryOutputStream | ( | size_t | initialSize = 256 | ) |
Creates an empty memory stream ready for writing into.
| initialSize | the intial amount of capacity to allocate for writing into |
| MemoryOutputStream::MemoryOutputStream | ( | MemoryBlock & | memoryBlockToWriteTo, |
| bool | appendToExistingBlockContent | ||
| ) |
Creates a memory stream for writing into into a pre-existing MemoryBlock object.
Note that the destination block will always be larger than the amount of data that has been written to the stream, because the MemoryOutputStream keeps some spare capactity at its end. To trim the block's size down to fit the actual data, call flush(), or delete the MemoryOutputStream.
| memoryBlockToWriteTo | the block into which new data will be written. |
| appendToExistingBlockContent | if this is true, the contents of the block will be kept, and new data will be appended to it. If false, the block will be cleared before use |
Destructor.
This will free any data that was written to it.
| const void* MemoryOutputStream::getData | ( | ) | const |
Returns a pointer to the data that has been written to the stream.
| size_t MemoryOutputStream::getDataSize | ( | ) | const |
Returns the number of bytes of data that have been written to the stream.
| void MemoryOutputStream::reset | ( | ) |
Resets the stream, clearing any data that has been written to it so far.
| void MemoryOutputStream::preallocate | ( | size_t | bytesToPreallocate | ) |
Increases the internal storage capacity to be able to contain at least the specified amount of data without needing to be resized.
| String MemoryOutputStream::toUTF8 | ( | ) | const |
Returns a String created from the (UTF8) data that has been written to the stream.
| String MemoryOutputStream::toString | ( | ) | const |
Attempts to detect the encoding of the data and convert it to a string.
Returns a copy of the stream's data as a memory block.
| void MemoryOutputStream::flush | ( | ) | [virtual] |
If the stream is writing to a user-supplied MemoryBlock, this will trim any excess capacity off the block, so that its length matches the amount of actual data that has been written so far.
Implements OutputStream.
| bool MemoryOutputStream::write | ( | const void * | dataToWrite, |
| int | numberOfBytes | ||
| ) | [virtual] |
Writes a block of data to the stream.
When creating a subclass of OutputStream, this is the only write method that needs to be overloaded - the base class has methods for writing other types of data which use this to do the work.
| dataToWrite | the target buffer to receive the data. This must not be null. |
| numberOfBytes | the number of bytes to write. This must not be negative. |
Implements OutputStream.
| int64 MemoryOutputStream::getPosition | ( | ) | [virtual] |
| bool MemoryOutputStream::setPosition | ( | int64 | newPosition | ) | [virtual] |
Tries to move the stream's output position.
Not all streams will be able to seek to a new position - this will return false if it fails to work.
Implements OutputStream.
| int MemoryOutputStream::writeFromInputStream | ( | InputStream & | source, |
| int64 | maxNumBytesToWrite | ||
| ) | [virtual] |
Reads data from an input stream and writes it to this stream.
| source | the stream to read from |
| maxNumBytesToWrite | the number of bytes to read from the stream (if this is less than zero, it will keep reading until the input is exhausted) |
Reimplemented from OutputStream.
| void MemoryOutputStream::writeRepeatedByte | ( | uint8 | byte, |
| int | numTimesToRepeat | ||
| ) | [virtual] |
Writes a byte to the output stream a given number of times.
Reimplemented from OutputStream.
