as_orderedmap.h File Reference

#include <aerospike/as_std.h>
#include <aerospike/as_map.h>
#include <aerospike/as_pair.h>

Include dependency graph for as_orderedmap.h:

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

Go to the source code of this file.

Data Structures
struct	as_orderedmap
struct	as_orderedmap_iterator
struct	map_entry

Functions
AS_EXTERN int	as_orderedmap_clear (as_orderedmap *map)
AS_EXTERN void	as_orderedmap_destroy (as_orderedmap *map)
AS_EXTERN bool	as_orderedmap_foreach (const as_orderedmap *map, as_map_foreach_callback callback, void *udata)
AS_EXTERN as_val *	as_orderedmap_get (const as_orderedmap *map, const as_val *key)
AS_EXTERN as_orderedmap *	as_orderedmap_init (as_orderedmap *map, uint32_t capacity)
AS_EXTERN void	as_orderedmap_iterator_destroy (as_orderedmap_iterator *it)
AS_EXTERN bool	as_orderedmap_iterator_has_next (const as_orderedmap_iterator *it)
AS_EXTERN as_orderedmap_iterator *	as_orderedmap_iterator_init (as_orderedmap_iterator *it, const as_orderedmap *map)
AS_EXTERN as_orderedmap_iterator *	as_orderedmap_iterator_new (const as_orderedmap *map)
AS_EXTERN const as_val *	as_orderedmap_iterator_next (as_orderedmap_iterator *it)
AS_EXTERN as_orderedmap *	as_orderedmap_new (uint32_t capacity)
AS_EXTERN int	as_orderedmap_remove (as_orderedmap *map, const as_val *key)
AS_EXTERN int	as_orderedmap_set (as_orderedmap *map, const as_val *key, const as_val *val)
static void	as_orderedmap_set_flags (as_orderedmap *map, uint32_t flags)
AS_EXTERN uint32_t	as_orderedmap_size (const as_orderedmap *map)

Function Documentation

as_orderedmap_clear()

AS_EXTERN int as_orderedmap_clear

(

as_orderedmap *

map

)

Remove all entries from the map.

Parameters

map

The map.

Returns

0 on success. Otherwise an error occurred.

as_orderedmap_destroy()

AS_EXTERN void as_orderedmap_destroy

(

as_orderedmap *

map

)

Free the map and associated resources.

Parameters

map	The map to destroy.

as_orderedmap_foreach()

AS_EXTERN bool as_orderedmap_foreach	(	const as_orderedmap *	map,
		as_map_foreach_callback	callback,
		void *	udata )

Call the callback function for each entry in the map.

Parameters

map	The map.
callback	The function to call for each entry.
udata	User-data to be passed to the callback.

Returns

true if iteration completes fully. false if iteration was aborted.

as_orderedmap_get()

AS_EXTERN as_val * as_orderedmap_get	(	const as_orderedmap *	map,
		const as_val *	key )

Get the value for specified key.

Parameters

map	The map.
key	The key.

Returns

The value for the specified key. Otherwise NULL.

as_orderedmap_init()

AS_EXTERN as_orderedmap * as_orderedmap_init	(	as_orderedmap *	map,
		uint32_t	capacity )

Initialize a stack allocated orderedmap.

Parameters

map	The map to initialize.
capacity	The number of entries (keys) to allocate for.

Returns

On success, the initialized map. Otherwise NULL.

as_orderedmap_iterator_destroy()

AS_EXTERN void as_orderedmap_iterator_destroy

(

as_orderedmap_iterator *

it

)

Destroy the iterator and releases resources used by the iterator.

Parameters

it	The iterator to release

as_orderedmap_iterator_has_next()

AS_EXTERN bool as_orderedmap_iterator_has_next

(

const as_orderedmap_iterator *

it

)

Tests if there are more values available in the iterator.

Parameters

it	The iterator to be tested.

Returns

true if there are more values. Otherwise false.

as_orderedmap_iterator_init()

AS_EXTERN as_orderedmap_iterator * as_orderedmap_iterator_init	(	as_orderedmap_iterator *	it,
		const as_orderedmap *	map )

Initializes a stack allocated as_iterator for the given as_orderedmap.

Parameters

it	The iterator to initialize.
map	The map to iterate.

Returns

On success, the initialized iterator. Otherwise NULL.

as_orderedmap_iterator_new()

AS_EXTERN as_orderedmap_iterator * as_orderedmap_iterator_new

(

const as_orderedmap *

map

)

Creates a heap allocated as_iterator for the given as_orderedmap.

Parameters

map	The map to iterate.

Returns

On success, the new iterator. Otherwise NULL.

as_orderedmap_iterator_next()

AS_EXTERN const as_val * as_orderedmap_iterator_next

(

as_orderedmap_iterator *

it

)

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

Parameters

it	The iterator to get the next value from.

Returns

The next value in the list if available. Otherwise NULL.

as_orderedmap_new()

AS_EXTERN as_orderedmap * as_orderedmap_new

(

uint32_t

capacity

)

Creates a new map as an orderedmap.

Parameters

capacity

The number of keys to allocate for.

Returns

On success, the new map. Otherwise NULL.

as_orderedmap_remove()

AS_EXTERN int as_orderedmap_remove	(	as_orderedmap *	map,
		const as_val *	key )

Remove the entry specified by the key.

Parameters

map	The map to remove the entry from.
key	The key of the entry to be removed.

Returns

0 on success. Otherwise an error occurred.

as_orderedmap_set()

AS_EXTERN int as_orderedmap_set	(	as_orderedmap *	map,
		const as_val *	key,
		const as_val *	val )

Set the value for specified key.

Parameters

map	The map.
key	The key.
val	The value for the given key.

Returns

0 on success. Otherwise an error occurred.

as_orderedmap_set_flags()

static void as_orderedmap_set_flags ( as_orderedmap * map, uint32_t flags )

inlinestatic

Set map attributes.

Definition at line 291 of file as_orderedmap.h.

as_orderedmap_size()

AS_EXTERN uint32_t as_orderedmap_size

(

const as_orderedmap *

map

)

Get the number of entries in the map.

Parameters

map

The map.

Returns

The number of entries in the map.