nvs: support iteration over namespace by index (IDFGH-9782) #11118
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
github-actions
bot
changed the title
|
Thanks for your contribution. |
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.
igrr
approved these changes
Apr 12, 2023
|
sha=2850cc67b8ace5051b7c4b7f0a255c30eb6e8eb5 |
espressif-bot
added
Status: In Progress
igrr
reviewed
Apr 13, 2023
| * nvs_release_iterator(it); | ||
| * \endcode | ||
| * | ||
| * @param[in] handle Handle obtained from nvs_open function. |
There was a problem hiding this comment.
Over here Doxygen complains that the argument name (handle) doesn't match the argument name in function declaration (c_handle). I'll fix this to use handle name in the declaration, consistent with the rest of the functions.
There was a problem hiding this comment.
Ah, whoops, ya. I originally wrote this change for the esp-idf 4.x and then ported it to 5.x. Seems I didn't fully fix the doxygen comments after that.
espressif-bot
added
Status: Reviewing
espressif-bot
added
Status: Done
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Users of the nvs API are likely to have
nvs_handle_tin all cases, but not all of them carry around the partition name and namespace name (as they aren't needed after creating annvs_handle_t).Allow this common case to use nvs iteration without them tracking additional data by using the
nvs_handle_tto locate the namespace index and the partition name by introducing an alternative tonvs_entry_findcallednvs_entry_find_in_handle, which operates similarly except that it is given anvs_handle_tinstead of partition and namespace strings.This is somewhat more limited than the
nvs_entry_findAPI as one cannot examine all keys in a given partition.