water::MemoryOutputStream Class Reference

#include <MemoryOutputStream.h>

Inheritance diagram for water::MemoryOutputStream:

Public Member Functions
	MemoryOutputStream (size_t initialSize=256)
	MemoryOutputStream (MemoryBlock &memoryBlockToWriteTo, bool appendToExistingBlockContent)
	~MemoryOutputStream ()
const void *	getData () const noexcept
void *	getDataAndRelease () noexcept
size_t	getDataSize () const noexcept
void	reset () noexcept
void	preallocate (size_t bytesToPreallocate)
bool	appendUTF8Char (water_uchar character)
String	toUTF8 () const
String	toString () const
MemoryBlock	getMemoryBlock () const
void	flush () override
bool	write (const void *, size_t) override
int64	getPosition () override
bool	setPosition (int64) override
int64	writeFromInputStream (InputStream &, int64 maxNumBytesToWrite) override
bool	writeRepeatedByte (uint8 byte, size_t numTimesToRepeat) override
Public Member Functions inherited from water::OutputStream
virtual	~OutputStream ()
virtual bool	writeByte (char byte)
virtual bool	writeBool (bool boolValue)
virtual bool	writeShort (short value)
virtual bool	writeShortBigEndian (short value)
virtual bool	writeInt (int value)
virtual bool	writeIntBigEndian (int value)
virtual bool	writeInt64 (int64 value)
virtual bool	writeInt64BigEndian (int64 value)
virtual bool	writeFloat (float value)
virtual bool	writeFloatBigEndian (float value)
virtual bool	writeDouble (double value)
virtual bool	writeDoubleBigEndian (double value)
virtual bool	writeCompressedInt (int value)
virtual bool	writeString (const String &text)
virtual bool	writeText (const String &text, bool asUTF16, bool writeUTF16ByteOrderMark)
void	setNewLineString (const String &newLineString)
const String &	getNewLineString () const noexcept

Private Member Functions
void	trimExternalBlockSize ()
char *	prepareToWrite (size_t)

Private Attributes
MemoryBlock	internalBlock
MemoryBlock &	blockToUse
size_t	position
size_t	size
bool	usingInternalBlock

Additional Inherited Members
Protected Member Functions inherited from water::OutputStream
	OutputStream ()

Detailed Description

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.

Constructor & Destructor Documentation

MemoryOutputStream() [1/2]

water::MemoryOutputStream::MemoryOutputStream

(

size_t

initialSize = 256

)

Creates an empty memory stream, ready to be written into.

Parameters

initialSize

the intial amount of capacity to allocate for writing into

MemoryOutputStream() [2/2]

water::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.

Parameters

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

~MemoryOutputStream()

water::MemoryOutputStream::~MemoryOutputStream

(

)

Destructor. This will free any data that was written to it.

Member Function Documentation

appendUTF8Char()

bool water::MemoryOutputStream::appendUTF8Char

(

water_uchar

character

)

Appends the utf-8 bytes for a unicode character

flush()

void water::MemoryOutputStream::flush ( )

overridevirtual

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 water::OutputStream.

getData()

const void * water::MemoryOutputStream::getData ( ) const

noexcept

Returns a pointer to the data that has been written to the stream.

See also

getDataSize

getDataAndRelease()

void * water::MemoryOutputStream::getDataAndRelease ( )

noexcept

Returns a pointer to the data that has been written to the stream and releases the buffer pointer.

See also

getDataSize

getDataSize()

size_t water::MemoryOutputStream::getDataSize ( ) const

inlinenoexcept

Returns the number of bytes of data that have been written to the stream.

See also

getData

getMemoryBlock()

MemoryBlock water::MemoryOutputStream::getMemoryBlock

(

)

const

Returns a copy of the stream's data as a memory block.

getPosition()

int64 water::MemoryOutputStream::getPosition ( )

inlineoverridevirtual

Returns the stream's current position.

See also

setPosition

Implements water::OutputStream.

preallocate()

void water::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.

prepareToWrite()

char * water::MemoryOutputStream::prepareToWrite ( size_t numBytes )

private

reset()

void water::MemoryOutputStream::reset ( )

noexcept

Resets the stream, clearing any data that has been written to it so far.

setPosition()

bool water::MemoryOutputStream::setPosition ( int64 newPosition )

overridevirtual

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.

See also

getPosition

Implements water::OutputStream.

toString()

String water::MemoryOutputStream::toString

(

)

const

Attempts to detect the encoding of the data and convert it to a string.

See also

String::createStringFromData

toUTF8()

String water::MemoryOutputStream::toUTF8

(

)

const

Returns a String created from the (UTF8) data that has been written to the stream.

trimExternalBlockSize()

void water::MemoryOutputStream::trimExternalBlockSize ( )

private

write()

bool water::MemoryOutputStream::write ( const void * dataToWrite, size_t numberOfBytes )

overridevirtual

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.

Parameters

dataToWrite	the target buffer to receive the data. This must not be null.
numberOfBytes	the number of bytes to write.

Returns

false if the write operation fails for some reason

Implements water::OutputStream.

writeFromInputStream()

int64 water::MemoryOutputStream::writeFromInputStream ( InputStream & source, int64 maxNumBytesToWrite )

overridevirtual

Reads data from an input stream and writes it to this stream.

Parameters

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)

Returns

the number of bytes written

Reimplemented from water::OutputStream.

writeRepeatedByte()

bool water::MemoryOutputStream::writeRepeatedByte ( uint8 byte, size_t numTimesToRepeat )

overridevirtual

Writes a byte to the output stream a given number of times.

Returns

false if the write operation fails for some reason

Reimplemented from water::OutputStream.

Member Data Documentation

blockToUse

MemoryBlock& water::MemoryOutputStream::blockToUse

private

internalBlock

MemoryBlock water::MemoryOutputStream::internalBlock

private

position

size_t water::MemoryOutputStream::position

private

size

size_t water::MemoryOutputStream::size

private

usingInternalBlock

bool water::MemoryOutputStream::usingInternalBlock

private

---

The documentation for this class was generated from the following files:

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/streams/MemoryOutputStream.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/streams/MemoryOutputStream.cpp