condy::ProvidedBuffer Struct Reference

Provided buffer. More...

#include <provided_buffers.hpp>

Public Member Functions
void *	data () const noexcept
	Get the data pointer of the provided buffer.
size_t	size () const noexcept
	Get the size of the provided buffer.
void	reset () noexcept
	Reset the provided buffer, returning it to the pool if owned.
bool	owns_buffer () const noexcept
	Check if the provided buffer owns a buffer from a pool.

Detailed Description

Provided buffer.

A provided buffer represents a buffer obtained from a provided buffer pool. It automatically returns the buffer to the pool when it goes out of scope.

Note

The lifetime of the provided buffer must not exceed the lifetime of the provided buffer pool it is associated with.

Definition at line 211 of file provided_buffers.hpp.

Member Function Documentation

size()

size_t condy::ProvidedBuffer::size ( ) const

inlinenoexcept

Get the size of the provided buffer.

Definition at line 244 of file provided_buffers.hpp.

---

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

• include/condy/provided_buffers.hpp