GiBuffer Struct Reference

#include <gi_buffer.h>

List of all members.

Public Attributes
void *	data
size_t	size
size_t	len
bool	resize_ok

---

Detailed Description

Buffer object storing the current parameters of the buffer, as well as the allocated data stream.

---

Member Data Documentation

void* GiBuffer::data

Pointer to the beginning of the data buffer. This should be accessed through gi_buffer_head. The tail (the last _valid_ byte) can be accessed through gi_buffer_tail.

size_t GiBuffer::len

Number of bytes actually written to the data buffer so far. This is independent of `size', except that it may never exceed it's value. It is expected that more sophisticated usage of this object will update this member manually.

bool GiBuffer::resize_ok

Determines whether or not the data object pointed to by `data' can be resized internally with realloc. This is important when a user-controlled data buffer is supplied through ::gi_buffer_set which should not be resized.

size_t GiBuffer::size

The current size allocated to (or supported by) the data buffer. If `resize_ok' is true, this size may grow or shrink as needed.

---

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

• gi_buffer.h

---