as_arraylist_iterator.h File Reference

#include <aerospike/as_arraylist.h>
#include <aerospike/as_iterator.h>
#include <aerospike/as_std.h>

Include dependency graph for as_arraylist_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_arraylist_iterator

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)

Function Documentation

as_arraylist_iterator_destroy()

AS_EXTERN void as_arraylist_iterator_destroy

(

as_arraylist_iterator *

iterator

)

Destroy the iterator and releases resources used by the iterator.

Parameters

iterator

The iterator to release

as_arraylist_iterator_has_next()

AS_EXTERN bool as_arraylist_iterator_has_next

(

const as_arraylist_iterator *

iterator

)

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.

as_arraylist_iterator_init()

AS_EXTERN as_arraylist_iterator * as_arraylist_iterator_init	(	as_arraylist_iterator *	iterator,
		const as_arraylist *	list )

Initializes a stack allocated as_iterator for as_arraylist.

Parameters

iterator	The iterator to initialize.
list	The list to iterate.

Returns

On success, the initialized iterator. Otherwise NULL.

as_arraylist_iterator_new()

AS_EXTERN as_arraylist_iterator * as_arraylist_iterator_new

(

const as_arraylist *

list

)

Creates a new heap allocated as_iterator for as_arraylist.

Parameters

list	The list to iterate.

Returns

On success, the new iterator. Otherwise NULL.

as_arraylist_iterator_next()

AS_EXTERN const as_val * as_arraylist_iterator_next

(

as_arraylist_iterator *

iterator

)

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 in the list if available. Otherwise NULL.