Data Structures
struct	zms_fs
	Zephyr Memory Storage file system structure. More...
struct	zms_iter_config
	Iterator configuration for zms_iter_init_with_config. More...
struct	zms_iter
	Opaque iterator state for zms_iter_next and zms_iter_next_all. More...

Macros
#define	ZMS_DATA_IN_ATE_SIZE 8
	Maximum data size in bytes that ZMS stores directly inside an ATE.
#define	ZMS_ITER_ID_MIN ((zms_id_t)0)
	Default minimum ID accepted by iterator range filtering.
#define	ZMS_ITER_ID_MAX ((zms_id_t)~(zms_id_t)0)
	Default maximum ID accepted by iterator range filtering.
#define	ZMS_ITER_MASK_ALL ZMS_ITER_ID_MAX
	Default mask that accepts all IDs during iterator filtering.
#define	ZMS_ITER_CONFIG_DEFAULT
	Default initializer for zms_iter_config.

Typedefs
typedef uint32_t	zms_id_t
	ID type used in the ZMS API.
typedef bool(*	zms_iter_predicate_t) (zms_id_t id)
	Iterator predicate callback type used by zms_iter_init_with_config.

Enumerations
enum	zms_mount_flags { ZMS_MOUNT_FLAG_NO_FORMAT = BIT(0) }
	Mount options for zms_mount and zms_mount_force. More...

Detailed Description

Macro Definition Documentation

◆ ZMS_DATA_IN_ATE_SIZE

#define ZMS_DATA_IN_ATE_SIZE 8

#include <zephyr/kvss/zms.h>

Maximum data size in bytes that ZMS stores directly inside an ATE.

Entries whose data length does not exceed this value are kept in the ATE itself rather than in the sector's data area. Its width depends on CONFIG_ZMS_ID_64BIT. This is the maximum amount of data that the iterator (zms_iter_next / zms_iter_next_all) can copy into a caller-provided buffer.

◆ ZMS_ITER_CONFIG_DEFAULT

#define ZMS_ITER_CONFIG_DEFAULT

#include <zephyr/kvss/zms.h>

Value:

{ \
        .mask_id = ZMS_ITER_MASK_ALL, \
        .min_id = ZMS_ITER_ID_MIN, \
        .max_id = ZMS_ITER_ID_MAX, \
        .use_mask = false, \
        .use_range = false, \
        .use_predicate = false, \
        .predicate_func = NULL, \
}