mem::nvs::Base::Iterator Struct Reference

Wrapper around C-style NVS iterators

#include <base.hpp>

Collaboration diagram for mem::nvs::Base::Iterator:

Public Types
using	value_type = nvs_entry_info_t
using	difference_type = std::ptrdiff_t
using	reference = value_type
using	iterator_category = std::input_iterator_tag

Public Member Functions
	Iterator (char const *namespace_name)
	Ctor.
	~Iterator ()
	Dtor.
reference	operator* () const
Iterator &	operator++ ()
void	operator++ (int)

Private Attributes
nvs_iterator_t	_it {}
esp_err_t	_err {}

Friends
constexpr bool	operator== (Iterator const &lhs, Sentinel)
	Equality comparison.

Member Typedef Documentation

difference_type

using mem::nvs::Base::Iterator::difference_type = std::ptrdiff_t

iterator_category

using mem::nvs::Base::Iterator::iterator_category = std::input_iterator_tag

reference

using mem::nvs::Base::Iterator::reference = value_type

value_type

using mem::nvs::Base::Iterator::value_type = nvs_entry_info_t

Constructor & Destructor Documentation

Iterator()

mem::nvs::Base::Iterator::Iterator ( char const * namespace_name )

inline

Creates an iterator to enumerate NVS entries.

Parameters

namespace_name

Namespace to iterate over

~Iterator()

mem::nvs::Base::Iterator::~Iterator ( )

inline

Release iterator.

Member Function Documentation

operator*()

reference mem::nvs::Base::Iterator::operator* ( ) const

inline

operator++() [1/2]

Iterator & mem::nvs::Base::Iterator::operator++ ( )

inline

operator++() [2/2]

void mem::nvs::Base::Iterator::operator++ ( int )

inline

Friends And Related Symbol Documentation

operator==

bool operator== ( Iterator const & lhs, Sentinel  )

friend

esp_err_t implicitly converts to bool. Any other value than 'ESP_OK' indicates that we have reached the end.

Returns

Return value of last call to nvs_entry_next

Member Data Documentation

_err

esp_err_t mem::nvs::Base::Iterator::_err {}

private

_it

nvs_iterator_t mem::nvs::Base::Iterator::_it {}

private

---

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

• /home/runner/work/Firmware/Firmware/src/mem/nvs/base.hpp