hf::host::MockNvs Class Reference

#include <MockNvs.h>

Inheritance diagram for hf::host::MockNvs:

Classes
struct	Entry

Public Member Functions
	MockNvs (const char *namespace_name="mock") noexcept
	~MockNvs () noexcept override=default
hf_nvs_err_t	Initialize () noexcept override
hf_nvs_err_t	Deinitialize () noexcept override
hf_nvs_err_t	SetU32 (const char *key, hf_u32_t value) noexcept override
hf_nvs_err_t	GetU32 (const char *key, hf_u32_t &value) noexcept override
hf_nvs_err_t	SetString (const char *key, const char *value) noexcept override
hf_nvs_err_t	GetString (const char *key, char *buffer, size_t buffer_size, size_t *actual_size=nullptr) noexcept override
hf_nvs_err_t	SetBlob (const char *key, const void *data, size_t data_size) noexcept override
hf_nvs_err_t	GetBlob (const char *key, void *buffer, size_t buffer_size, size_t *actual_size=nullptr) noexcept override
hf_nvs_err_t	EraseKey (const char *key) noexcept override
hf_nvs_err_t	Commit () noexcept override
bool	KeyExists (const char *key) noexcept override
hf_nvs_err_t	GetSize (const char *key, size_t &size) noexcept override
const char *	GetDescription () const noexcept override
size_t	GetMaxKeyLength () const noexcept override
size_t	GetMaxValueSize () const noexcept override
void	SetInitializeResult (hf_nvs_err_t result) noexcept
void	FailNext (hf_nvs_err_t error, size_t count=1) noexcept
void	SetReadOnly (bool read_only=true) noexcept
void	Clear () noexcept
int	CommitCalls () const noexcept
size_t	KeyCount () const noexcept

Static Public Attributes
static constexpr size_t	kMaxKeyLength = 15
	Same limit as ESP-IDF NVS.
static constexpr size_t	kMaxValueSize = 4000

Private Types
enum class	Type : uint8_t { U32 , String , Blob }

Private Member Functions
hf_nvs_err_t	CheckKey (const char *key) const noexcept
bool	ConsumeFailure (hf_nvs_err_t &error) noexcept
hf_nvs_err_t	Store (const char *key, Type type, const void *data, size_t size) noexcept

Private Attributes
hf_nvs_err_t	init_result_ {hf_nvs_err_t::NVS_SUCCESS}
std::map< std::string, Entry >	entries_
hf_nvs_err_t	fail_error_ {hf_nvs_err_t::NVS_ERR_FAILURE}
size_t	fail_count_ {0}
bool	read_only_ {false}
int	commit_calls_ {0}

Member Enumeration Documentation

Type

enum class hf::host::MockNvs::Type : uint8_t

strongprivate

Enumerator
U32
String
Blob

Constructor & Destructor Documentation

MockNvs()

hf::host::MockNvs::MockNvs ( const char *  namespace_name = "mock" )

explicitnoexcept

~MockNvs()

hf::host::MockNvs::~MockNvs ( )

overridedefaultnoexcept

Member Function Documentation

CheckKey()

hf_nvs_err_t hf::host::MockNvs::CheckKey ( const char *  key ) const

privatenoexcept

Clear()

void hf::host::MockNvs::Clear ( )

inlinenoexcept

Commit()

hf_nvs_err_t hf::host::MockNvs::Commit ( )

overridenoexcept

CommitCalls()

int hf::host::MockNvs::CommitCalls ( ) const

inlinenoexcept

ConsumeFailure()

bool hf::host::MockNvs::ConsumeFailure ( hf_nvs_err_t &  error )

privatenoexcept

Deinitialize()

hf_nvs_err_t hf::host::MockNvs::Deinitialize ( )

inlineoverridenoexcept

EraseKey()

hf_nvs_err_t hf::host::MockNvs::EraseKey ( const char *  key )

overridenoexcept

FailNext()

void hf::host::MockNvs::FailNext ( hf_nvs_err_t  error, size_t  count = 1  )

noexcept

GetBlob()

hf_nvs_err_t hf::host::MockNvs::GetBlob ( const char *  key, void *  buffer, size_t  buffer_size, size_t *  actual_size = nullptr  )

overridenoexcept

GetDescription()

const char * hf::host::MockNvs::GetDescription ( ) const

inlineoverridenoexcept

GetMaxKeyLength()

size_t hf::host::MockNvs::GetMaxKeyLength ( ) const

inlineoverridenoexcept

GetMaxValueSize()

size_t hf::host::MockNvs::GetMaxValueSize ( ) const

inlineoverridenoexcept

GetSize()

hf_nvs_err_t hf::host::MockNvs::GetSize ( const char *  key, size_t &  size  )

overridenoexcept

GetString()

hf_nvs_err_t hf::host::MockNvs::GetString ( const char *  key, char *  buffer, size_t  buffer_size, size_t *  actual_size = nullptr  )

overridenoexcept

GetU32()

hf_nvs_err_t hf::host::MockNvs::GetU32 ( const char *  key, hf_u32_t &  value  )

overridenoexcept

Initialize()

hf_nvs_err_t hf::host::MockNvs::Initialize ( )

inlineoverridenoexcept

KeyCount()

size_t hf::host::MockNvs::KeyCount ( ) const

inlinenoexcept

KeyExists()

bool hf::host::MockNvs::KeyExists ( const char *  key )

overridenoexcept

SetBlob()

hf_nvs_err_t hf::host::MockNvs::SetBlob ( const char *  key, const void *  data, size_t  data_size  )

overridenoexcept

SetInitializeResult()

void hf::host::MockNvs::SetInitializeResult ( hf_nvs_err_t  result )

inlinenoexcept

SetReadOnly()

void hf::host::MockNvs::SetReadOnly ( bool  read_only = true )

inlinenoexcept

SetString()

hf_nvs_err_t hf::host::MockNvs::SetString ( const char *  key, const char *  value  )

overridenoexcept

SetU32()

hf_nvs_err_t hf::host::MockNvs::SetU32 ( const char *  key, hf_u32_t  value  )

overridenoexcept

Store()

hf_nvs_err_t hf::host::MockNvs::Store ( const char *  key, Type  type, const void *  data, size_t  size  )

privatenoexcept

Member Data Documentation

commit_calls_

int hf::host::MockNvs::commit_calls_ {0}

private

entries_

std::map<std::string, Entry> hf::host::MockNvs::entries_

private

fail_count_

size_t hf::host::MockNvs::fail_count_ {0}

private

fail_error_

hf_nvs_err_t hf::host::MockNvs::fail_error_ {hf_nvs_err_t::NVS_ERR_FAILURE}

private

init_result_

hf_nvs_err_t hf::host::MockNvs::init_result_ {hf_nvs_err_t::NVS_SUCCESS}

private

kMaxKeyLength

constexpr size_t hf::host::MockNvs::kMaxKeyLength = 15

staticconstexpr

Same limit as ESP-IDF NVS.

kMaxValueSize

constexpr size_t hf::host::MockNvs::kMaxValueSize = 4000

staticconstexpr

read_only_

bool hf::host::MockNvs::read_only_ {false}

private

---

The documentation for this class was generated from the following files:

• MockNvs.h
• MockNvs.cpp