as_iterator.h File Reference

#include <aerospike/as_std.h>
#include <aerospike/as_util.h>
#include <aerospike/as_val.h>

Include dependency graph for as_iterator.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	as_iterator
struct	as_iterator_hooks

Functions
AS_EXTERN void	as_iterator_destroy (as_iterator *iterator)
static bool	as_iterator_has_next (const as_iterator *iterator)
AS_EXTERN as_iterator *	as_iterator_init (as_iterator *iterator, bool free, void *data, const as_iterator_hooks *hooks)
static const as_val *	as_iterator_next (as_iterator *iterator)

Function Documentation

as_iterator_destroy()

AS_EXTERN void as_iterator_destroy

(

as_iterator *

iterator

)

Destroys the iterator and releasing associated resources.

as_iterator_has_next()

static bool as_iterator_has_next ( const as_iterator * iterator )

inlinestatic

Tests if there are more values available in the iterator.

Parameters

iterator

The iterator to be tested.

Returns

true if there are more values, otherwise false.

Definition at line 104 of file as_iterator.h.

References as_util_hook.

as_iterator_init()

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

Initialize a stack allocated iterator.

as_iterator_next()

static const as_val * as_iterator_next ( as_iterator * iterator )

inlinestatic

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

Parameters

iterator

The iterator to get the next value from.

Returns

the next value available in the iterator.

Definition at line 117 of file as_iterator.h.

References as_util_hook.