class EE::System::IOStreamFileMapped

Overview

#include <iostreamfilemapped.hpp>

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

    IOStreamFileMapped();
    IOStreamFileMapped(const std::string& path);
    IOStreamFileMapped(FileMapped&& file);
    IOStreamFileMapped(const IOStreamFileMapped&);
    IOStreamFileMapped(IOStreamFileMapped&&);
    ~IOStreamFileMapped();

    // methods

    IOStreamFileMapped& operator=(const IOStreamFileMapped&);
    IOStreamFileMapped& operator=(IOStreamFileMapped&&);
    bool open(const std::string& path);
    void close();
    virtual ios_size read(char* data, ios_size size);
    virtual ios_size write(const char* data, ios_size size);
    virtual ios_size seek(ios_size position);
    virtual ios_size tell();
    virtual ios_size getSize();
    virtual bool isOpen();
    const FileMapped& getMappedFile() const;
    FileMapped& getMappedFile();
    const std::string& getLastError() 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

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 written

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