Common::MemoryWriteStream Class Reference

#include <memstream.h>

Inheritance diagram for Common::MemoryWriteStream:

Public Member Functions
	MemoryWriteStream (byte *buf, uint32 len)
uint32	write (const void *dataPtr, uint32 dataSize) override
int64	pos () const override
int64	size () const override
bool	err () const override
void	clearErr () override
bool	seek (int64 offset, int whence=SEEK_SET) override
Public Member Functions inherited from Common::WriteStream
virtual bool	flush ()
virtual void	finalize ()
void	writeByte (byte value)
void	writeSByte (int8 value)
void	writeUint16LE (uint16 value)
void	writeUint32LE (uint32 value)
void	writeUint64LE (uint64 value)
void	writeUint16BE (uint16 value)
void	writeUint32BE (uint32 value)
void	writeUint64BE (uint64 value)
FORCEINLINE void	writeSint16LE (int16 value)
FORCEINLINE void	writeSint32LE (int32 value)
FORCEINLINE void	writeSint64LE (int64 value)
FORCEINLINE void	writeSint16BE (int16 value)
FORCEINLINE void	writeSint32BE (int32 value)
FORCEINLINE void	writeSint64BE (int64 value)
FORCEINLINE void	writeFloatLE (float value)
FORCEINLINE void	writeFloatBE (float value)
FORCEINLINE void	writeDoubleLE (double value)
FORCEINLINE void	writeDoubleBE (double value)
template<class TDataFormat , class... T>
bool	writeMultiple (const TDataFormat &dataFormat, const T &...values)
template<class... T>
bool	writeMultipleEndian (bool isLittle, const T &...values)
template<class... T>
bool	writeMultipleLE (const T &...values)
template<class... T>
bool	writeMultipleBE (const T &...values)
uint32	writeStream (ReadStream *stream, uint32 dataSize)
uint32	writeStream (ReadStream *stream)
void	writeString (const String &str)

Protected Attributes
byte *	_ptr
uint32	_pos
bool	_err

Detailed Description

Simple memory based 'stream', which implements the WriteStream interface for a plain memory block.

Member Function Documentation

write()

uint32 Common::MemoryWriteStream::write ( const void *  dataPtr, uint32  dataSize  )

inlineoverridevirtual

Write data into the stream. Subclasses must implement this method. All other write methods are implemented using it.

Note

The semantics of any implementation of this method is supposed to match that of ISO C fwrite().

Parameters

dataPtr	Pointer to the data to be written.
dataSize	Number of bytes to be written.

Returns

The number of bytes that were actually written.

Implements Common::WriteStream.

pos()

int64 Common::MemoryWriteStream::pos ( ) const

inlineoverridevirtual

Obtain the current value of the stream position indicator.

Returns

The current position indicator, or -1 if an error occurred.

Implements Common::WriteStream.

size()

int64 Common::MemoryWriteStream::size ( ) const

inlineoverridevirtual

Obtain the current size of the stream, measured in bytes.

If this value is unknown or cannot be computed, -1 is returned.

Returns

The size of the stream, or -1 if an error occurred.

Implements Common::SeekableWriteStream.

err()

bool Common::MemoryWriteStream::err ( ) const

inlineoverridevirtual

Return true if an I/O failure occurred.

This flag is never cleared automatically. In order to clear it, the client code must call clearErr() explicitly.

Note

The semantics of any implementation of this method is supposed to match that of ISO C ferror().

Reimplemented from Common::Stream.

clearErr()

void Common::MemoryWriteStream::clearErr ( )

inlineoverridevirtual

Reset the I/O error status as returned by err().

For a ReadStream, also reset the end-of-stream status returned by eos().

Note

The semantics of any implementation of this method is supposed to match that of ISO C clearerr().

Reimplemented from Common::Stream.

seek()

bool Common::MemoryWriteStream::seek ( int64  offset, int  whence = SEEK_SET  )

inlineoverridevirtual

Set the stream position indicator for the stream.

The new position, measured in bytes, is obtained by adding offset bytes to the position specified by whence. If whence is set to SEEK_SET, SEEK_CUR, or SEEK_END, the offset is relative to the start of the file, the current position indicator, or end-of-stream, respectively. A successful call to the seek() method clears the end-of-stream indicator for the stream.

Note

The semantics of any implementation of this method is supposed to match that of ISO C fseek().

Parameters

offset	The relative offset in bytes.
whence	The seek reference: SEEK_SET, SEEK_CUR, or SEEK_END.

Returns

True on success, false in case of a failure.

Implements Common::SeekableWriteStream.

Reimplemented in Common::SeekableMemoryWriteStream.

---

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

• common/memstream.h