ScummVM API documentation
Bagel::SaveReadWriteStream Class Reference

#include <file.h>

Inheritance diagram for Bagel::SaveReadWriteStream:
Common::MemoryWriteStreamDynamic Bagel::SaveReadStream Common::SeekableWriteStream Common::WriteStream Common::Stream

Public Member Functions

 SaveReadWriteStream (Common::WriteStream *save)
 
int64 pos () const override
 
bool seek (int64 offset, int whence=SEEK_SET) override
 
int64 size () const override
 
- Public Member Functions inherited from Common::MemoryWriteStreamDynamic
 MemoryWriteStreamDynamic (DisposeAfterUse::Flag disposeMemory)
 
uint32 write (const void *dataPtr, uint32 dataSize) override
 
byte * getData ()
 
- 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)
 
- Public Member Functions inherited from Common::Stream
virtual bool err () const
 
virtual void clearErr ()
 

Additional Inherited Members

- Protected Member Functions inherited from Common::MemoryWriteStreamDynamic
void ensureCapacity (uint32 capacity)
 
- Static Protected Member Functions inherited from Common::MemoryWriteStreamDynamic
static size_t roundUpCapacity (size_t capacity)
 
- Protected Attributes inherited from Common::MemoryWriteStreamDynamic
uint32 _capacity
 
uint32 _size
 
byte * _ptr
 
byte * _data
 
uint32 _pos
 
DisposeAfterUse::Flag _disposeMemory
 

Detailed Description

Used as a wrapper for writing out original saves using the console, since it also does reads from the stream whilst open

Member Function Documentation

◆ pos()

int64 Bagel::SaveReadWriteStream::pos ( ) const
inlineoverridevirtual

Obtain the current value of the stream position indicator.

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

Reimplemented from Common::MemoryWriteStreamDynamic.

◆ seek()

bool Bagel::SaveReadWriteStream::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
offsetThe relative offset in bytes.
whenceThe seek reference: SEEK_SET, SEEK_CUR, or SEEK_END.
Returns
True on success, false in case of a failure.

Reimplemented from Common::MemoryWriteStreamDynamic.

◆ size()

int64 Bagel::SaveReadWriteStream::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.

Reimplemented from Common::MemoryWriteStreamDynamic.


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