bpf::io::ByteBuf class final
#include <Base/include/Framework/IO/ByteBuf.hpp>

Contents

Low-level fixed size buffer that can store raw bytes

Base classes

class IInputStream
class IOutputStream

Constructors, destructors, conversion operators

ByteBuf(fsize size) explicit
ByteBuf(ByteBuf&& other) noexcept
ByteBuf(const ByteBuf& other)
~ByteBuf() final

Public functions

auto operator=(const ByteBuf& other) -> ByteBuf&
auto operator=(ByteBuf&& other) -> ByteBuf& noexcept
void Clear()
void Reset()
void Shift(fsize count)
auto Write(const void* buf, fsize bufsize) -> fsize final
auto Read(void* buf, fsize bufsize) -> fsize final
auto operator*() -> uint8* noexcept
auto operator*() const -> const uint8* noexcept
auto Size() const -> fsize noexcept
auto GetCursor() const -> fsize noexcept
auto GetWrittenBytes() const -> fsize noexcept
void Seek(const fsize pos)
auto operator[](const fsize id) const -> uint8
auto operator[](const fsize id) -> uint8&

Function documentation

bpf::io::ByteBuf::ByteBuf(fsize size) explicit

Parameters
size the maximum size in bytes of the buffer

Constructs a ByteBuf WARNING: ByteBuf does not automatically set bytes to 0

bpf::io::ByteBuf::ByteBuf(ByteBuf&& other) noexcept

Move constructor

bpf::io::ByteBuf::ByteBuf(const ByteBuf& other)

Copy constructor

ByteBuf& bpf::io::ByteBuf::operator=(const ByteBuf& other)

Copy assignment operator

ByteBuf& bpf::io::ByteBuf::operator=(ByteBuf&& other) noexcept

Move assignment operator

void bpf::io::ByteBuf::Clear()

Clears this buffer by resetting all bytes inside to the value 0

void bpf::io::ByteBuf::Reset()

Reset the pointers of this buffer to the beginning

void bpf::io::ByteBuf::Shift(fsize count)

Parameters
count number of bytes for shifting

Shift the bytes in this buffer

fsize bpf::io::ByteBuf::Write(const void* buf, fsize bufsize) final

Parameters
buf the buffer with the bytes to write
bufsize the size of the buffer
Returns number of bytes written
Exceptions
IOException in case of system error

Writes bytes to this stream WARNING: When possible the implementation should not buffer

fsize bpf::io::ByteBuf::Read(void* buf, fsize bufsize) final

Parameters
buf buffer to receive the read bytes
bufsize the size of the receiving buffer
Returns number of bytes read
Exceptions
IOException in case of system error

Reads bytes from this stream WARNING: When possible the implementation should not buffer

uint8* bpf::io::ByteBuf::operator*() noexcept

Returns mutable pointer to the buffer start

Returns a raw pointer to the beginning of this buffer

const uint8* bpf::io::ByteBuf::operator*() const noexcept

Returns immutable pointer to the buffer start

Returns a raw pointer to the beginning of this buffer

fsize bpf::io::ByteBuf::Size() const noexcept

Returns size in bytes as unsigned

Returns the maximum size of this buffer

fsize bpf::io::ByteBuf::GetCursor() const noexcept

Returns cursor location as unsigned

Returns the location of the read/write head

fsize bpf::io::ByteBuf::GetWrittenBytes() const noexcept

Returns number of bytes written as unsigned

Returns the number of bytes written

void bpf::io::ByteBuf::Seek(const fsize pos)

Parameters
pos new cursor position as unsigned
Exceptions
IndexException if pos out of bounds

Change location of read/write head

uint8 bpf::io::ByteBuf::operator[](const fsize id) const

Parameters
id the index of the byte to get
Returns copy of the byte at index id
Exceptions
IndexException if index out of bounds

Returns a byte at a given index