cx_iterator_base_s Struct Reference

The base of mutating and non-mutating iterators. More...

#include <iterator.h>

Data Fields
bool(*	valid )(void const *)
	True iff the iterator points to valid data.
void *(*	current )(void const *)
	Returns a pointer to the current element.
void *(*	current_impl )(void const *)
	Original implementation in case the function needs to be wrapped.
void(*	next )(void *)
	Advances the iterator.
bool(*	flag_removal )(void *)
	Flag current element for removal, if possible.
bool	mutating
	Indicates whether this iterator may remove elements.
bool	remove
	Internal flag for removing the current element when advancing.

Detailed Description

The base of mutating and non-mutating iterators.

Field Documentation

current

void *(* cx_iterator_base_s::current) (void const *)

Returns a pointer to the current element.

When valid returns false, the behavior of this function is undefined.

flag_removal

bool(* cx_iterator_base_s::flag_removal) (void *)

Flag current element for removal, if possible.

When valid returns false, the behavior of this function is undefined.

next

void(* cx_iterator_base_s::next) (void *)

Advances the iterator.

When valid returns false, the behavior of this function is undefined.

---

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

• /home/mike/workspace/c/ucx/src/cx/iterator.h