cubos::core::memory::BufferStream class

#include <core/memory/buffer_stream.hpp>

Base classes

class Stream

Interface class for memory streams. Abstracts away sources or destinations of data.

Constructors, destructors, conversion operators

BufferStream(void* buffer, std::size_t size, bool readOnly = false)

Constructs using an existing buffer.

BufferStream(const void* buffer, std::size_t size)

Constructs using a read-only buffer.

BufferStream(std::size_t size = 16)

Constructs using a new buffer, managed internally and which grows as needed.

BufferStream(const BufferStream& other)

Constructs a copy of another buffer stream. If the given buffer stream owns its buffer, the copy will also create its own buffer. Otherwise, it will share the buffer with the original.

BufferStream(BufferStream&& other) noexcept

Move constructs.

Public functions

auto getBuffer() const -> const void*

Gets the buffer of this stream.

auto string() const -> std::string

Creates a string from the buffer of this stream.

auto read(void* data, std::size_t size) -> std::size_t override

Reads data from the stream.

auto write(const void* data, std::size_t size) -> std::size_t override

Writes data to the stream.

auto tell() const -> std::size_t override

Gets the current position in the stream.

void seek(ptrdiff_t offset, SeekOrigin origin) override

Seeks to a position in the stream.

auto eof() const -> bool override

Checks if the stream still has content to read.

auto peek() -> char override

Peeks one byte from the stream.

Function documentation