nonowning_buffer Class Reference

Read and modify buffered bytes in caller-owned storage. More...

#include <nonowning_buffer.hpp>

Inheritance diagram for nonowning_buffer:

Collaboration diagram for nonowning_buffer:

Public Member Functions
	nonowning_buffer (uint8_t *buffer, size_t capacity) noexcept
	nonowning_buffer (uint8_t *buffer, size_t capacity, size_t size) noexcept
	nonowning_buffer (nonowning_buffer const &)=default
nonowning_buffer &	operator= (nonowning_buffer const &)=default
	nonowning_buffer (nonowning_buffer &&) noexcept=default
nonowning_buffer &	operator= (nonowning_buffer &&) noexcept=default
size_t	capacity () const override
size_t	size () const override
bool	empty () const
	operator bool () const
void	resize (size_t size) override
	Resizes the buffer.
void	clear () override
uint8_t	operator[] (size_t offset)
	Gets element at offset. No safety check.
void	consume (size_t bytes) override
	Removes consumed bytes from the beginning of the buffer.
void	reset ()
void	append (uint8_t const *data, size_t len) override
void	append (uint8_t c)
void	append (std::string_view const &str)
std::string_view	to_view () const
Direct access
get() exposes active bytes. get(n) prepares tail space without changing size; commit the written bytes with add(n). Requests exceeding capacity abort.
uint8_t const *	get () const override
uint8_t *	get () override
uint8_t *	get (size_t bytes) override
void	add (size_t bytes) override
Public Member Functions inherited from buffer_access_interface
virtual void	append (unsigned char const *data, size_t len)=0

Additional Inherited Members
Protected Member Functions inherited from buffer_access_interface
	buffer_access_interface (buffer_access_interface const &)=default
buffer_access_interface &	operator= (buffer_access_interface const &)=default

Detailed Description

Read and modify buffered bytes in caller-owned storage.

The supplied memory range must remain valid for the buffer's lifetime. Capacity is fixed; requests exceeding it abort. Copies and moves are shallow. Destruction leaves the supplied storage allocated and unchanged.

Member Function Documentation

add()

void add ( size_t bytes )

overridevirtual

Implements buffer_access_interface.

capacity()

size_t capacity ( ) const

inlineoverridevirtual

Implements buffer_access_interface.

clear()

void clear ( )

inlineoverridevirtual

Implements buffer_access_interface.

consume()

void consume ( size_t bytes )

overridevirtual

Removes consumed bytes from the beginning of the buffer.

Undefined if consumed > size()

Implements buffer_access_interface.

get() [1/3]

uint8_t const * get ( ) const

inlineoverridevirtual

Implements buffer_access_interface.

get() [2/3]

uint8_t * get ( )

inlineoverridevirtual

Implements buffer_access_interface.

get() [3/3]

uint8_t * get ( size_t bytes )

overridevirtual

Implements buffer_access_interface.

resize()

void resize ( size_t size )

overridevirtual

Resizes the buffer.

If growing, memory isn't cleared. Aborts if size exceeds capacity.

Implements buffer_access_interface.

size()

size_t size ( ) const

inlineoverridevirtual

Implements buffer_access_interface.

---

The documentation for this class was generated from the following file:

• nonowning_buffer.hpp