Buffer Lifecycle

Functions for creating and destroying buffers. More...

Functions
DB_DEF db_buffer	db_new (size_t capacity)
	Create a new empty buffer with specified capacity.
DB_DEF db_buffer	db_new_with_data (const void *data, size_t size)
	Create a new buffer initialized with data (copies the data)
DB_DEF db_buffer	db_new_from_owned_data (void *data, size_t size, size_t capacity)
	Create a new buffer by copying existing data.
DB_DEF db_buffer	db_retain (db_buffer buf)
	Increase reference count (share ownership)
DB_DEF void	db_release (db_buffer *buf_ptr)
	Decrease reference count and potentially free buffer.

Detailed Description

Functions for creating and destroying buffers.

Function Documentation

db_new()

DB_DEF db_buffer db_new

(

size_t

capacity

)

Create a new empty buffer with specified capacity.

Parameters

capacity

Initial capacity in bytes (0 for minimal allocation)

Returns

New buffer instance (asserts on allocation failure)

db_new_from_owned_data()

DB_DEF db_buffer db_new_from_owned_data	(	void *	data,
		size_t	size,
		size_t	capacity
	)

Create a new buffer by copying existing data.

Parameters

data	Pointer to data to copy
size	Size of the data in bytes
capacity	Total allocated capacity (must be >= size)

Returns

New buffer instance or NULL on invalid parameters (asserts on allocation failure)

Note

This function copies the data into the new buffer. You are responsible for freeing the original data if needed.

db_new_with_data()

DB_DEF db_buffer db_new_with_data	(	const void *	data,
		size_t	size
	)

Create a new buffer initialized with data (copies the data)

Parameters

data	Pointer to source data (can be NULL if size is 0)
size	Number of bytes to copy

Returns

New buffer instance (asserts on allocation failure)

Example:

db_buffer buf = db_new_with_data("Hello", 5);
if (buf) {
    printf("Buffer size: %zu\n", db_size(buf));
    db_release(&buf);
}

db_release()

DB_DEF void db_release

(

db_buffer *

buf_ptr

)

Decrease reference count and potentially free buffer.

Parameters

buf_ptr

Pointer to buffer variable (will be set to NULL)

db_retain()

DB_DEF db_buffer db_retain

(

db_buffer

buf

)

Increase reference count (share ownership)

Parameters

buf	Buffer to retain (can be NULL)

Returns

The same buffer for convenience