Iterator for as_arraylist.
To use the iterator, you can either initialize a stack allocated variable, using as_arraylist_iterator_init()
:
Or you can create a new heap allocated variable, using as_arraylist_iterator_new()
:
To iterate, use as_arraylist_iterator_has_next()
and as_arraylist_iterator_next()
:
When you are finished using the iterator, then you should release the iterator and associated resources:
The as_arraylist_iterator
is a subtype of as_iterator
. This allows you to alternatively use as_iterator
functions, by typecasting as_arraylist_iterator
to as_iterator
.
Each of the as_iterator
functions proxy to the as_arraylist_iterator
functions. So, calling as_iterator_destroy()
is equivalent to calling as_arraylist_iterator_destroy()
.
Definition at line 88 of file as_arraylist_iterator.h.
#include "as_arraylist_iterator.h"
Data Fields | |
const as_arraylist * | list |
uint32_t | pos |
Data Fields inherited from as_iterator | |
void * | data |
const struct as_iterator_hooks_s * | hooks |
Related Functions | |
(Note that these are not member functions.) | |
AS_EXTERN void | as_arraylist_iterator_destroy (as_arraylist_iterator *iterator) |
AS_EXTERN bool | as_arraylist_iterator_has_next (const as_arraylist_iterator *iterator) |
AS_EXTERN as_arraylist_iterator * | as_arraylist_iterator_init (as_arraylist_iterator *iterator, const as_arraylist *list) |
AS_EXTERN as_arraylist_iterator * | as_arraylist_iterator_new (const as_arraylist *list) |
AS_EXTERN const as_val * | as_arraylist_iterator_next (as_arraylist_iterator *iterator) |
|
related |
Destroy the iterator and releases resources used by the iterator.
iterator | The iterator to release |
|
related |
Tests if there are more values available in the iterator.
iterator | The iterator to be tested. |
|
related |
Initializes a stack allocated as_iterator for as_arraylist.
iterator | The iterator to initialize. |
list | The list to iterate. |
|
related |
Creates a new heap allocated as_iterator for as_arraylist.
list | The list to iterate. |
|
related |
Attempts to get the next value from the iterator. This will return the next value, and iterate past the value.
iterator | The iterator to get the next value from. |
const as_arraylist* as_arraylist_iterator::list |
The as_arraylist being iterated over
Definition at line 99 of file as_arraylist_iterator.h.
uint32_t as_arraylist_iterator::pos |
The current position of the iteration
Definition at line 104 of file as_arraylist_iterator.h.