icy

ConstBuffer

The ConstBuffer class provides a safe representation of a buffer that cannot be modified.

#include <buffer.h>

class ConstBuffer

Defined in src/base/include/icy/buffer.h:142

The ConstBuffer class provides a safe representation of a buffer that cannot be modified. It does not own the underlying data, and so is cheap to copy or assign.

Public Methods

ReturnNameDescription
constexprConstBuffer inline constexprConstruct an empty buffer.
constexprConstBuffer inline constexprConstruct a buffer to represent the given memory range.
constexprConstBuffer inline constexprConstruct a non-modifiable buffer from a modifiable one.
const void *data const inline nodiscard constexpr
size_tsize const inline nodiscard constexpr
const char *cstr const inline nodiscardCast the buffer as a const char pointer.
std::stringstr const inlineReturns the buffer as a string.

ConstBuffer

inline constexpr

constexpr inline constexpr ConstBuffer()

Defined in src/base/include/icy/buffer.h:146

Construct an empty buffer.


ConstBuffer

inline constexpr

constexpr inline constexpr ConstBuffer(const void * data, size_t size)

Defined in src/base/include/icy/buffer.h:153

Construct a buffer to represent the given memory range.


ConstBuffer

inline constexpr

constexpr inline constexpr ConstBuffer(const MutableBuffer & b)

Defined in src/base/include/icy/buffer.h:160

Construct a non-modifiable buffer from a modifiable one.


data

const inline nodiscard constexpr

[[nodiscard]] constexpr inline const void * data() const

Defined in src/base/include/icy/buffer.h:166


size

const inline nodiscard constexpr

[[nodiscard]] constexpr inline size_t size() const

Defined in src/base/include/icy/buffer.h:167


cstr

const inline nodiscard

[[nodiscard]] inline const char * cstr() const

Defined in src/base/include/icy/buffer.h:170

Cast the buffer as a const char pointer.


str

const inline

inline std::string str() const

Defined in src/base/include/icy/buffer.h:173

Returns the buffer as a string.

Protected Attributes

ReturnNameDescription
const void *_data
size_t_size

_data

const void * _data

Defined in src/base/include/icy/buffer.h:176


_size

size_t _size

Defined in src/base/include/icy/buffer.h:177