cx_iterator_s Struct Reference

Internal iterator struct - use CxIterator. More...

#include <iterator.h>

Data Fields
struct cx_iterator_base_s	base
	Inherited common data for all iterators.
void *	elem_handle
	Handle for the current element.
union {
void *   m
	Access for mutating iterators.
const void *   c
	Access for normal iterators.
}	src_handle
	Handle for the source collection, if any.
size_t	index
	If the iterator is position-aware, contains the index of the element in the underlying collection.
size_t	elem_size
	The size of an individual element.
size_t	elem_count
	May contain the total number of elements, if known.

Detailed Description

Internal iterator struct - use CxIterator.

Field Documentation

elem_count

size_t cx_iterator_s::elem_count

May contain the total number of elements, if known.

Shall be set to SIZE_MAX when the total number is unknown during iteration.

index

size_t cx_iterator_s::index

If the iterator is position-aware, contains the index of the element in the underlying collection.

Otherwise, this field is usually uninitialized.

---

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

• src/cx/iterator.h