BitWriter

#include <buffer.h>

class BitWriter

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

Subclassed by: DynamicBitWriter

Note that when using the constructor with the Buffer reference as an argument, the writer will dynamically expand the given buffer when writing passed the buffer capacity. All other cases will throw a std::out_of_range error when writing past the buffer capacity.

Friends

Name	Description
`operator<<` inline

operator<<

inline

friend inline std::ostream & operator<<(std::ostream & stream, const BitWriter & wr)

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

Public Methods

Return	Name	Description
	`BitWriter`	Constructs a `[BitWriter](#bitwriter)` over a raw byte array with a fixed capacity.
	`BitWriter`	Constructs a `[BitWriter](#bitwriter)` backed by a `[Buffer](base.html#buffer)`. Writes are bounded by the buffer's capacity; use `[DynamicBitWriter](icy-DynamicBitWriter.html#dynamicbitwriter)` for auto-resize.
	`BitWriter`	Constructs a `[BitWriter](#bitwriter)` over a `[MutableBuffer](icy-MutableBuffer.html#mutablebuffer-6)` with a fixed capacity.
	`~BitWriter` virtual
`void`	`put` virtual	Append bytes to the buffer. Throws a `std::out_of_range` exception if reading past the limit.
`void`	`put`	Appends the contents of a string. Throws `std::out_of_range` if capacity is exceeded.
`void`	`putU8`	Appends an unsigned 8-bit integer. Throws `std::out_of_range` if capacity is exceeded.
`void`	`putU16`	Appends an unsigned 16-bit integer with byte-order conversion. Throws `std::out_of_range` if capacity is exceeded.
`void`	`putU24`	Appends the low 24 bits of a 32-bit integer with byte-order conversion. Throws `std::out_of_range` if capacity is exceeded.
`void`	`putU32`	Appends an unsigned 32-bit integer with byte-order conversion. Throws `std::out_of_range` if capacity is exceeded.
`void`	`putU64`	Appends an unsigned 64-bit integer with byte-order conversion. Throws `std::out_of_range` if capacity is exceeded.
`bool`	`update` virtual	Update a byte range. Throws a `std::out_of_range` exception if reading past the limit.
`bool`	`update`	Overwrites a previously written string at the given absolute position.
`bool`	`updateU8`	Overwrites a `uint8_t` at the given absolute position.
`bool`	`updateU16`	Overwrites a `uint16_t` at the given absolute position, with byte-order conversion.
`bool`	`updateU24`	Overwrites 3 bytes (low 24 bits of `val`) at the given absolute position, with byte-order conversion.
`bool`	`updateU32`	Overwrites a `uint32_t` at the given absolute position, with byte-order conversion.
`bool`	`updateU64`	Overwrites a `uint64_t` at the given absolute position, with byte-order conversion.
`void`	`seek`	Set position pointer to absolute position. Throws a `std::out_of_range` exception if the value exceeds the limit.
`void`	`skip`	Set position pointer to relative position. Throws a `std::out_of_range` exception if the value exceeds the limit.
`size_t`	`limit` const nodiscard	Returns the write limit.
`size_t`	`position` const inline nodiscard	Returns the current write position.
`size_t`	`available` const nodiscard	Returns the number of elements between the current write position and the limit.
`char *`	`begin` inline nodiscard	Returns a pointer to the start of the write buffer.
`char *`	`current` inline nodiscard	Returns a pointer to the current write position.
`const char *`	`begin` const inline nodiscard	Returns a const pointer to the start of the write buffer.
`const char *`	`current` const inline nodiscard	Returns a const pointer to the current write position.
`ByteOrder`	`order` const inline	Returns the byte order used for multi-byte integer writes.
`std::string`	`toString`	Returns all bytes written so far as a `std::string`.

BitWriter(char * bytes, size_t size, ByteOrder order = ByteOrder::Network)

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

Constructs a [BitWriter](#bitwriter) over a raw byte array with a fixed capacity.

Parameters

Parameter	Type	Description
`bytes`	`char *`	Pointer to the writable buffer. Must remain valid for the writer's lifetime.
`size`	`size_t`	Capacity of the buffer in bytes.
`order`	`ByteOrder`	Byte order used for multi-byte integer writes.

BitWriter

BitWriter(Buffer & buf, ByteOrder order = ByteOrder::Network)

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

Constructs a [BitWriter](#bitwriter) backed by a [Buffer](base.html#buffer). Writes are bounded by the buffer's capacity; use [DynamicBitWriter](icy-DynamicBitWriter.html#dynamicbitwriter) for auto-resize.

Parameters

Parameter	Type	Description
`buf`	`Buffer` &	Source buffer. Must remain valid for the writer's lifetime.
`order`	`ByteOrder`	Byte order used for multi-byte integer writes.

BitWriter

BitWriter(MutableBuffer & pod, ByteOrder order = ByteOrder::Network)

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

Constructs a [BitWriter](#bitwriter) over a [MutableBuffer](icy-MutableBuffer.html#mutablebuffer-6) with a fixed capacity.

Parameters

Parameter	Type	Description
`pod`	`MutableBuffer` &	Source mutable buffer. Must remain valid for the writer's lifetime.
`order`	`ByteOrder`	Byte order used for multi-byte integer writes.

~BitWriter

virtual

virtual ~BitWriter()

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

put

virtual

virtual void put(const char * val, size_t len)

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

Append bytes to the buffer. Throws a std::out_of_range exception if reading past the limit.

Reimplemented by

DynamicBitWriter::put

put

void put(const std::string & val)

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

Appends the contents of a string. Throws std::out_of_range if capacity is exceeded.

Parameters

Parameter	Type	Description
`val`	`const std::string &`	String whose bytes are appended.

putU8

void putU8(uint8_t val)

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

Appends an unsigned 8-bit integer. Throws std::out_of_range if capacity is exceeded.

Parameters

Parameter	Type	Description
`val`	`uint8_t`	Value to write.

putU16

void putU16(uint16_t val)

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

Appends an unsigned 16-bit integer with byte-order conversion. Throws std::out_of_range if capacity is exceeded.

Parameters

Parameter	Type	Description
`val`	`uint16_t`	Value to write.

putU24

void putU24(uint32_t val)

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

Appends the low 24 bits of a 32-bit integer with byte-order conversion. Throws std::out_of_range if capacity is exceeded.

Parameters

Parameter	Type	Description
`val`	`uint32_t`	Value to write (only the lower 3 bytes are written).

putU32

void putU32(uint32_t val)

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

Appends an unsigned 32-bit integer with byte-order conversion. Throws std::out_of_range if capacity is exceeded.

Parameters

Parameter	Type	Description
`val`	`uint32_t`	Value to write.

putU64

void putU64(uint64_t val)

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

Appends an unsigned 64-bit integer with byte-order conversion. Throws std::out_of_range if capacity is exceeded.

Parameters

Parameter	Type	Description
`val`	`uint64_t`	Value to write.

update

virtual

virtual bool update(const char * val, size_t len, size_t pos)

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

Update a byte range. Throws a std::out_of_range exception if reading past the limit.

Reimplemented by

DynamicBitWriter::update

update

bool update(const std::string & val, size_t pos)

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

Overwrites a previously written string at the given absolute position.

Returns

True on success, false if the range exceeds available space.

Parameters

Parameter	Type	Description
`val`	`const std::string &`	String to write.
`pos`	`size_t`	Absolute byte offset to overwrite at.

updateU8

bool updateU8(uint8_t val, size_t pos)

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

Overwrites a uint8_t at the given absolute position.

Returns

True on success, false if the range exceeds available space.

Parameters

Parameter	Type	Description
`val`	`uint8_t`	Value to write.
`pos`	`size_t`	Absolute byte offset to overwrite at.

updateU16

bool updateU16(uint16_t val, size_t pos)

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

Overwrites a uint16_t at the given absolute position, with byte-order conversion.

Returns

True on success, false if the range exceeds available space.

Parameters

Parameter	Type	Description
`val`	`uint16_t`	Value to write.
`pos`	`size_t`	Absolute byte offset to overwrite at.

updateU24

bool updateU24(uint32_t val, size_t pos)

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

Overwrites 3 bytes (low 24 bits of val) at the given absolute position, with byte-order conversion.

Returns

True on success, false if the range exceeds available space.

Parameters

Parameter	Type	Description
`val`	`uint32_t`	Value to write.
`pos`	`size_t`	Absolute byte offset to overwrite at.

updateU32

bool updateU32(uint32_t val, size_t pos)

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

Overwrites a uint32_t at the given absolute position, with byte-order conversion.

Returns

True on success, false if the range exceeds available space.

Parameters

Parameter	Type	Description
`val`	`uint32_t`	Value to write.
`pos`	`size_t`	Absolute byte offset to overwrite at.

updateU64

bool updateU64(uint64_t val, size_t pos)

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

Overwrites a uint64_t at the given absolute position, with byte-order conversion.

Returns

True on success, false if the range exceeds available space.

Parameters

Parameter	Type	Description
`val`	`uint64_t`	Value to write.
`pos`	`size_t`	Absolute byte offset to overwrite at.

seek

void seek(size_t val)

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

Set position pointer to absolute position. Throws a std::out_of_range exception if the value exceeds the limit.

skip

void skip(size_t size)

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

Set position pointer to relative position. Throws a std::out_of_range exception if the value exceeds the limit.

limit

const nodiscard

[[nodiscard]] size_t limit() const

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

Returns the write limit.

position

const inline nodiscard

[[nodiscard]] inline size_t position() const

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

Returns the current write position.

available

const nodiscard

[[nodiscard]] size_t available() const

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

Returns the number of elements between the current write position and the limit.

begin

inline nodiscard

[[nodiscard]] inline char * begin()

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

Returns a pointer to the start of the write buffer.

current

inline nodiscard

[[nodiscard]] inline char * current()

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

Returns a pointer to the current write position.

begin

const inline nodiscard

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

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

Returns a const pointer to the start of the write buffer.

current

const inline nodiscard

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

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

Returns a const pointer to the current write position.

order

const inline

inline ByteOrder order() const

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

Returns the byte order used for multi-byte integer writes.

toString

std::string toString()

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

Returns all bytes written so far as a std::string.

Returns

String containing bytes from the start of the buffer up to the current position.

Protected Attributes

Return	Name	Description
`size_t`	`_position`
`size_t`	`_limit`
`ByteOrder`	`_order`
`char *`	`_bytes`

_position

size_t _position

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

_limit

size_t _limit

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

_order

ByteOrder _order

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

_bytes

char * _bytes

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

Protected Methods

Return	Name	Description
`void`	`init` virtual

init

virtual

virtual void init(char * bytes, size_t size, ByteOrder order)

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