sys_hashmap_iterator Struct Reference

Generic Hashmap iterator interface. More...

#include <hash_map_api.h>

Data Fields
const struct sys_hashmap *	map
	Pointer to the associated Hashmap.
void(*	next )(struct sys_hashmap_iterator *it)
	Modify the iterator in-place to point to the next Hashmap entry.
void *	state
	Implementation-specific iterator state.
uint64_t	key
	Key associated with the current entry.
uint64_t	value
	Value associated with the current entry.
const size_t	size
	Number of entries in the map.
size_t	pos
	Number of entries already iterated.

Detailed Description

Generic Hashmap iterator interface.

Note

next should not be used without first checking sys_hashmap_iterator_has_next

Field Documentation

key

uint64_t sys_hashmap_iterator::key

Key associated with the current entry.

map

const struct sys_hashmap* sys_hashmap_iterator::map

Pointer to the associated Hashmap.

next

void(* sys_hashmap_iterator::next) (struct sys_hashmap_iterator *it)

Modify the iterator in-place to point to the next Hashmap entry.

pos

size_t sys_hashmap_iterator::pos

Number of entries already iterated.

size

const size_t sys_hashmap_iterator::size

Number of entries in the map.

state

void* sys_hashmap_iterator::state

Implementation-specific iterator state.

value

uint64_t sys_hashmap_iterator::value

Value associated with the current entry.

---

The documentation for this struct was generated from the following file:

• include/zephyr/sys/hash_map_api.h