libpromeki/main/stringiodevice_8h_source.html

#pragma once


#include <promeki/core/namespace.h>

#include <promeki/core/iodevice.h>

#include <promeki/core/string.h>


PROMEKI_NAMESPACE_BEGIN


class StringIODevice : public IODevice {

        PROMEKI_OBJECT(StringIODevice, IODevice)

        public:

                explicit StringIODevice(String *string, ObjectBase *parent = nullptr);


                explicit StringIODevice(ObjectBase *parent = nullptr);


                ~StringIODevice() override;


                void setString(String *string);


                String *string() const { return _string; }


                Error open(OpenMode mode) override;

                Error close() override;

                bool isOpen() const override;

                int64_t read(void *data, int64_t maxSize) override;

                int64_t write(const void *data, int64_t maxSize) override;

                int64_t bytesAvailable() const override;

                bool isSequential() const override;

                Error seek(int64_t pos) override;

                int64_t pos() const override;

                Result<int64_t> size() const override;

                bool atEnd() const override;


        private:

                String  *_string = nullptr;

                int64_t _pos     = 0;

};


PROMEKI_NAMESPACE_END

Error
Lightweight error code wrapper for the promeki library.
Definition error.h:39

IODevice
Abstract base class for all I/O devices.
Definition iodevice.h:29

IODevice::OpenMode
OpenMode
Mode flags controlling how a device is opened.
Definition iodevice.h:33

List
Dynamic array container wrapping std::vector.
Definition list.h:40

ObjectBase
Base object for promeki.
Definition objectbase.h:129

ObjectBase::parent
ObjectBase * parent() const
Returns the parent object, if one. nullptr if none.
Definition objectbase.h:258

StringIODevice
IODevice backed by a promeki String.
Definition stringiodevice.h:33

StringIODevice::StringIODevice
StringIODevice(ObjectBase *parent=nullptr)
Constructs a StringIODevice with no string.

StringIODevice::open
Error open(OpenMode mode) override
Opens the device with the specified mode.

StringIODevice::setString
void setString(String *string)
Sets the underlying String.

StringIODevice::pos
int64_t pos() const override
Returns the current read/write position.

StringIODevice::bytesAvailable
int64_t bytesAvailable() const override
Returns the number of bytes available for reading.

StringIODevice::write
int64_t write(const void *data, int64_t maxSize) override
Writes up to maxSize bytes from data.

StringIODevice::read
int64_t read(void *data, int64_t maxSize) override
Reads up to maxSize bytes into data.

StringIODevice::StringIODevice
StringIODevice(String *string, ObjectBase *parent=nullptr)
Constructs a StringIODevice with an external String.

StringIODevice::atEnd
bool atEnd() const override
Returns true if the current position is at the end.

StringIODevice::isOpen
bool isOpen() const override
Returns true if the device is open.

StringIODevice::size
Result< int64_t > size() const override
Returns the total size of the device in bytes.

StringIODevice::close
Error close() override
Closes the device.

StringIODevice::seek
Error seek(int64_t pos) override
Seeks to the given byte offset from the beginning.

StringIODevice::~StringIODevice
~StringIODevice() override
Destructor.

StringIODevice::string
String * string() const
Returns the underlying String, or nullptr.
Definition stringiodevice.h:68

StringIODevice::isSequential
bool isSequential() const override
Returns true if the device is sequential (non-seekable).

String
Encoding-aware string class with copy-on-write semantics.
Definition string.h:35

iodevice.h

namespace.h

PROMEKI_NAMESPACE_BEGIN
#define PROMEKI_NAMESPACE_BEGIN
Starts a promeki namespace block.
Definition namespace.h:14

PROMEKI_NAMESPACE_END
#define PROMEKI_NAMESPACE_END
Ends a promeki namespace block.
Definition namespace.h:19

string.h