zms_iter_config Struct Reference

Iterator configuration for zms_iter_init_with_config. More...

#include <zms.h>

Data Fields
zms_id_t	mask_id
	Mask applied when use_mask is true.
zms_id_t	min_id
	Minimum accepted ID when use_range is true.
zms_id_t	max_id
	Maximum accepted ID when use_range is true.
bool	use_mask
	Enable mask-based filtering.
bool	use_range
	Enable inclusive range-based filtering.
bool	use_predicate
	Enable callback-based filtering.
zms_iter_predicate_t	predicate_func
	Predicate callback used when use_predicate is true.

Detailed Description

Iterator configuration for zms_iter_init_with_config.

Leave use_mask, use_range, and use_predicate disabled to use the default behavior: all IDs in the full zms_id_t range are accepted.

Field Documentation

mask_id

zms_id_t zms_iter_config::mask_id

Mask applied when use_mask is true.

max_id

zms_id_t zms_iter_config::max_id

Maximum accepted ID when use_range is true.

min_id

zms_id_t zms_iter_config::min_id

Minimum accepted ID when use_range is true.

predicate_func

zms_iter_predicate_t zms_iter_config::predicate_func

Predicate callback used when use_predicate is true.

use_mask

bool zms_iter_config::use_mask

Enable mask-based filtering.

use_predicate

bool zms_iter_config::use_predicate

Enable callback-based filtering.

use_range

bool zms_iter_config::use_range

Enable inclusive range-based filtering.

---

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

• include/zephyr/kvss/zms.h