Files
esp-idf/components/nvs_flash/src/nvs_handle_simple.cpp
T
Cody P Schafer f2af1c5305 nvs: support iteration over namespace by index
Users of the nvs API are likely to have `nvs_handle_t` in all cases, but
not all of them carry around the partition name and namespace name (as
they aren't needed after creating an `nvs_handle_t`).

Allow this common case to use nvs iteration without them tracking
additional data by using the `nvs_handle_t` to locate the namespace
index and the partition name by introducing an alterate to
`nvs_entry_find` called `nvs_entry_find_in_handle`, which operates
similarly except that it is given a `nvs_handle_t` instead of partition
and namespace strings.

This is somewhat more limited than the `nvs_entry_find` API as one
cannot examine all keys in a given partition.
2023-08-29 13:59:34 +02:00

138 lines
3.7 KiB
C++

/*
* SPDX-FileCopyrightText: 2015-2023 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <cstdlib>
#include "nvs_handle.hpp"
#include "nvs_partition_manager.hpp"
namespace nvs {
NVSHandleSimple::~NVSHandleSimple() {
NVSPartitionManager::get_instance()->close_handle(this);
}
esp_err_t NVSHandleSimple::set_typed_item(ItemType datatype, const char *key, const void* data, size_t dataSize)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
if (mReadOnly) return ESP_ERR_NVS_READ_ONLY;
return mStoragePtr->writeItem(mNsIndex, datatype, key, data, dataSize);
}
esp_err_t NVSHandleSimple::get_typed_item(ItemType datatype, const char *key, void* data, size_t dataSize)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
return mStoragePtr->readItem(mNsIndex, datatype, key, data, dataSize);
}
esp_err_t NVSHandleSimple::set_string(const char *key, const char* str)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
if (mReadOnly) return ESP_ERR_NVS_READ_ONLY;
return mStoragePtr->writeItem(mNsIndex, nvs::ItemType::SZ, key, str, strlen(str) + 1);
}
esp_err_t NVSHandleSimple::set_blob(const char *key, const void* blob, size_t len)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
if (mReadOnly) return ESP_ERR_NVS_READ_ONLY;
return mStoragePtr->writeItem(mNsIndex, nvs::ItemType::BLOB, key, blob, len);
}
esp_err_t NVSHandleSimple::get_string(const char *key, char* out_str, size_t len)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
return mStoragePtr->readItem(mNsIndex, nvs::ItemType::SZ, key, out_str, len);
}
esp_err_t NVSHandleSimple::get_blob(const char *key, void* out_blob, size_t len)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
return mStoragePtr->readItem(mNsIndex, nvs::ItemType::BLOB, key, out_blob, len);
}
esp_err_t NVSHandleSimple::get_item_size(ItemType datatype, const char *key, size_t &size)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
return mStoragePtr->getItemDataSize(mNsIndex, datatype, key, size);
}
esp_err_t NVSHandleSimple::erase_item(const char* key)
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
if (mReadOnly) return ESP_ERR_NVS_READ_ONLY;
return mStoragePtr->eraseItem(mNsIndex, key);
}
esp_err_t NVSHandleSimple::erase_all()
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
if (mReadOnly) return ESP_ERR_NVS_READ_ONLY;
return mStoragePtr->eraseNamespace(mNsIndex);
}
esp_err_t NVSHandleSimple::commit()
{
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
return ESP_OK;
}
esp_err_t NVSHandleSimple::get_used_entry_count(size_t& used_entries)
{
used_entries = 0;
if (!valid) return ESP_ERR_NVS_INVALID_HANDLE;
size_t used_entry_count;
esp_err_t err = mStoragePtr->calcEntriesInNamespace(mNsIndex, used_entry_count);
if(err == ESP_OK){
used_entries = used_entry_count;
}
return err;
}
void NVSHandleSimple::debugDump() {
return mStoragePtr->debugDump();
}
esp_err_t NVSHandleSimple::fillStats(nvs_stats_t& nvsStats) {
return mStoragePtr->fillStats(nvsStats);
}
esp_err_t NVSHandleSimple::calcEntriesInNamespace(size_t& usedEntries) {
return mStoragePtr->calcEntriesInNamespace(mNsIndex, usedEntries);
}
bool NVSHandleSimple::findEntry(nvs_opaque_iterator_t* it, const char* name) {
return mStoragePtr->findEntry(it, name);
}
bool NVSHandleSimple::findEntryNs(nvs_opaque_iterator_t* it) {
return mStoragePtr->findEntryNs(it, mNsIndex);
}
bool NVSHandleSimple::nextEntry(nvs_opaque_iterator_t* it) {
return mStoragePtr->nextEntry(it);
}
const char *NVSHandleSimple::get_partition_name() const {
return mStoragePtr->getPartName();
}
Storage *NVSHandleSimple::get_storage() const {
return mStoragePtr;
}
}