class EE::System::IOStreamString

Overview

Implementation of a memory stream file using an std::string as a container. More…

#include <iostreamstring.hpp>

class IOStreamString: public EE::System::IOStream {
public:
    // construction

    IOStreamString();
    IOStreamString(const std::string& filepath);

    // methods

    virtual ios_size read(char* data, ios_size size);
    virtual ios_size write(const char* data, ios_size size);
    virtual ios_size write(const std::string& string);
    virtual ios_size seek(ios_size position);
    virtual ios_size tell();
    virtual ios_size getSize();
    virtual bool isOpen();
    void clear();
    const char* getPositionPointer();
    const char* getStreamPointer() const;
    const std::string& getStream() const;
};

Inherited Members

public:
    // methods

    virtual ios_size read(char* data, ios_size size) = 0;
    virtual ios_size write(const char* data, ios_size size) = 0;
    virtual ios_size seek(ios_size position) = 0;
    virtual ios_size tell() = 0;
    virtual ios_size getSize() = 0;
    virtual bool isOpen() = 0;

Detailed Documentation

Implementation of a memory stream file using an std::string as a container.

Methods

virtual ios_size read(char* data, ios_size size)

Read data from the stream.

Parameters:

data	Buffer where to copy the read data
size	Desired number of bytes to read

Returns:

The number of bytes actually read

virtual ios_size write(const char* data, ios_size size)

Write data to the virtual file.

Parameters:

data	Data to write in the file
size	Size of the data that needs to be writed

virtual ios_size seek(ios_size position)

Change the current reading position.

Parameters:

position

The position to seek to, from the beginning

Returns:

The position actually sought to.

virtual ios_size tell()

Get the current reading position in the stream.

Returns:

The current position, or -1 on error.

virtual ios_size getSize()

Return the size of the stream.

Returns:

The total number of bytes available in the stream

virtual bool isOpen()

Returns:

If the virtual stream file is open

const char* getPositionPointer()

Returns:

Pointer to the current position in the stream

const char* getStreamPointer() const

Returns:

The pointer to the beggining of the stream