All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Functions
modules/common/target/Linux-x86_64/include/aerospike/as_iterator.h File Reference
#include <aerospike/as_util.h>
#include <aerospike/as_val.h>
#include <stdbool.h>
+ Include dependency graph for modules/common/target/Linux-x86_64/include/aerospike/as_iterator.h:

Go to the source code of this file.

Data Structures

struct  as_iterator
 
struct  as_iterator_hooks
 

Functions

void as_iterator_destroy (as_iterator *iterator)
 
bool as_iterator_has_next (const as_iterator *iterator)
 
as_iteratoras_iterator_init (as_iterator *iterator, bool free, void *data, const as_iterator_hooks *hooks)
 
const as_valas_iterator_next (as_iterator *iterator)
 

Function Documentation

void as_iterator_destroy ( as_iterator iterator)

Destroys the iterator and releasing associated resources.

bool as_iterator_has_next ( const as_iterator iterator)
inline

Tests if there are more values available in the iterator.

Parameters
iteratorThe iterator to be tested.
Returns
true if there are more values, otherwise false.

Definition at line 106 of file modules/common/target/Linux-x86_64/include/aerospike/as_iterator.h.

References as_util_hook.

as_iterator* as_iterator_init ( as_iterator iterator,
bool  free,
void *  data,
const as_iterator_hooks hooks 
)

Initialize a stack allocated iterator.

const as_val* as_iterator_next ( as_iterator iterator)
inline

Attempts to get the next value from the iterator. This will return the next value, and iterate past the value.

Parameters
iteratorThe iterator to get the next value from.
Returns
the next value available in the iterator.

Definition at line 119 of file modules/common/target/Linux-x86_64/include/aerospike/as_iterator.h.

References as_util_hook.