All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures | Functions
target/Linux-x86_64/include/aerospike/as_hashmap_iterator.h File Reference
#include <aerospike/as_hashmap.h>
#include <aerospike/as_iterator.h>
#include <stdbool.h>
+ Include dependency graph for target/Linux-x86_64/include/aerospike/as_hashmap_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_hashmap_iterator
 

Functions

void as_hashmap_iterator_destroy (as_hashmap_iterator *iterator)
 
bool as_hashmap_iterator_has_next (const as_hashmap_iterator *iterator)
 
as_hashmap_iteratoras_hashmap_iterator_init (as_hashmap_iterator *iterator, const as_hashmap *map)
 
as_hashmap_iteratoras_hashmap_iterator_new (const as_hashmap *map)
 
const as_valas_hashmap_iterator_next (as_hashmap_iterator *iterator)
 

Function Documentation

void as_hashmap_iterator_destroy ( as_hashmap_iterator iterator)

Destroy the iterator and releases resources used by the iterator.

Parameters
iteratorThe iterator to release
bool as_hashmap_iterator_has_next ( const as_hashmap_iterator iterator)

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.
as_hashmap_iterator* as_hashmap_iterator_init ( as_hashmap_iterator iterator,
const as_hashmap map 
)

Initializes a stack allocated as_iterator for the given as_hashmap.

Parameters
iteratorThe iterator to initialize.
mapThe map to iterate.
Returns
On success, the initialized iterator. Otherwise NULL.
as_hashmap_iterator* as_hashmap_iterator_new ( const as_hashmap map)

Creates a heap allocated as_iterator for the given as_hashmap.

Parameters
mapThe map to iterate.
Returns
On success, the new iterator. Otherwise NULL.
const as_val* as_hashmap_iterator_next ( as_hashmap_iterator iterator)

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