mysql::containers::buffers Namespace Reference

Namespaces
namespace	managed_buffer_sequence

Classes
class	Buffer_sequence_view
	Sequence of memory buffers. More...
class	Buffer_view
	Non-owning view of a memory buffer with a fixed size. More...
class	Grow_calculator
	Description of a heuristic to determine how much memory to allocate. More...
class	Grow_constraint
	Description of a heuristic to determine how much memory to allocate. More...
class	Managed_buffer
	Owned, growable, contiguous memory buffer. More...
class	Managed_buffer_sequence
	Owned, non-contiguous, growable memory buffer. More...
class	Preallocated_managed_buffer
class	Rw_buffer
	Non-owning read/write memory buffer manager with a fixed size. More...
class	Rw_buffer_sequence
	Non-owning manager for a fixed sequence of memory buffers, which is split into a read part and a write part, with a movable split position. More...

Enumerations
enum class	Grow_status { success , exceeds_max_size , out_of_memory }
	Error statuses for classes that use Grow_calculator. More...

Functions
std::string	debug_string (Grow_status status)
	Return a string that describes each enumeration value. More...
std::ostream &	operator<< (std::ostream &stream, Grow_status status)
	Write a string that describes the enumeration value to the stream. More...

Variables
const std::string	invalid_grow_status_string = "invalid"
	Return value from debug_string(Grow_status) when the parameter is not a valid value. More...
constexpr std::size_t	default_preallocated_managed_buffer_size

Enumeration Type Documentation

Grow_status

enum class mysql::containers::buffers::Grow_status

strong

Error statuses for classes that use Grow_calculator.

Enumerator
success	A grow operation succeeded. The data structure is now of the new size.
exceeds_max_size	A grow operation could not be performed because there is a configured maximum size. The data structure is unchanged.
out_of_memory	A grow operation failed because memory allocation failed. The data structure is unchanged.

Function Documentation

debug_string()

std::string mysql::containers::buffers::debug_string

(

Grow_status

status

)

Return a string that describes each enumeration value.

operator<<()

std::ostream & mysql::containers::buffers::operator<<	(	std::ostream &	stream,
		Grow_status	status
	)

Write a string that describes the enumeration value to the stream.

Variable Documentation

default_preallocated_managed_buffer_size

constexpr std::size_t mysql::containers::buffers::default_preallocated_managed_buffer_size

constexpr

Initial value:

=
    std::size_t(8 * 1024)

invalid_grow_status_string

const std::string mysql::containers::buffers::invalid_grow_status_string = "invalid"

Return value from debug_string(Grow_status) when the parameter is not a valid value.