Skip to content

IKeyValueStore

#include "crosspad/settings/IKeyValueStore.hpp"

Generated from crosspad/settings/IKeyValueStore.hpp in crosspad-core. Edit the header’s doxygen comments to change this page.

Abstract interface for key-value persistence.

Platform implementations:

  • ESP-IDF: NvsKeyValueStore (wraps NVS)
  • Arduino: PreferencesKeyValueStore (wraps NVS via Preferences.h)
  • Linux: FileKeyValueStore (wraps filesystem)

Members

MemberDescription
initPlatform only The platform calls it once at start-up (crosspad_platform_init).
saveBool
saveU8
saveI32
readBool
readU8
readI32
eraseAllErase all persisted data (factory reset)

Methods

Platform only The platform calls it once at start-up (crosspad_platform_init).

virtual bool init() = 0
virtual void saveBool(const char *ns, const char *key, bool value) = 0
virtual void saveU8(const char *ns, const char *key, uint8_t value) = 0
virtual void saveI32(const char *ns, const char *key, int32_t value) = 0
virtual bool readBool(const char *ns, const char *key, bool defaultVal) = 0
virtual uint8_t readU8(const char *ns, const char *key, uint8_t defaultVal) = 0
virtual int32_t readI32(const char *ns, const char *key, int32_t defaultVal) = 0
virtual void eraseAll() = 0

Erase all persisted data (factory reset)

Declared in crosspad/settings/IKeyValueStore.hpp:14.