rcutils_char_array_t Struct Reference

The structure holding the metadata for a char array. More...

#include <char_array.h>

Collaboration diagram for rcutils_char_array_t:

Public Attributes
char *	buffer
	A pointer to the allocated memory for this char array. More...
bool	owns_buffer
size_t	buffer_length
	The length of the data stored in the buffer pointer. More...
size_t	buffer_capacity
	The maximum capacity of the buffer pointer. More...
rcutils_allocator_t	allocator
	The allocator used to allocate and free the data in the pointer. More...

Detailed Description

The structure holding the metadata for a char array.

Member Data Documentation

buffer

char* rcutils_char_array_t::buffer

A pointer to the allocated memory for this char array.

owns_buffer

bool rcutils_char_array_t::owns_buffer

if this is true, we may safely free/realloc the buffer as needed; otherwise we will leave the buffer alone and alloc new memory if more space is needed

buffer_length

size_t rcutils_char_array_t::buffer_length

The length of the data stored in the buffer pointer.

buffer_capacity

size_t rcutils_char_array_t::buffer_capacity

The maximum capacity of the buffer pointer.

allocator

rcutils_allocator_t rcutils_char_array_t::allocator

The allocator used to allocate and free the data in the pointer.

---

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

• include/rcutils/types/char_array.h