display_device::SettingsPersistenceInterface Class Reference

A class for storing and loading settings data from a persistent medium. More...

#include <src/common/include/display_device/settings_persistence_interface.h>

Inheritance diagram for display_device::SettingsPersistenceInterface:

Public Member Functions
virtual bool	clear ()=0
	Clear the persistent settings data.
virtual std::optional< std::vector< std::uint8_t > >	load () const =0
	Load saved settings data.
virtual bool	store (const std::vector< std::uint8_t > &data)=0
	Store the provided data.
virtual	~SettingsPersistenceInterface ()=default
	Default virtual destructor.

Detailed Description

A class for storing and loading settings data from a persistent medium.

Member Function Documentation

clear()

virtual bool display_device::SettingsPersistenceInterface::clear ( )

nodiscardpure virtual

Clear the persistent settings data.

Returns

True if data was cleared, false otherwise.

*Examples**

SettingsPersistenceInterface* iface = getIface(...);
const auto result = iface->clear();

Implemented in display_device::FileSettingsPersistence, and display_device::NoopSettingsPersistence.

load()

virtual std::optional< std::vector< std::uint8_t > > display_device::SettingsPersistenceInterface::load ( ) const

nodiscardpure virtual

Load saved settings data.

Returns

Null optional if failed to load data. Empty array, if there is no data. Non-empty array, if some data was loaded.

*Examples**

const SettingsPersistenceInterface* iface = getIface(...);
const auto opt_data = iface->load();

Implemented in display_device::FileSettingsPersistence, and display_device::NoopSettingsPersistence.

store()

virtual bool display_device::SettingsPersistenceInterface::store ( const std::vector< std::uint8_t > & data )

nodiscardpure virtual

Store the provided data.

Parameters

data	Data array to store.

Returns

True on success, false otherwise.

*Examples**

std::vector<std::uint8_t> data;
SettingsPersistenceInterface* iface = getIface(...);
const auto result = iface->store(data);

Implemented in display_device::FileSettingsPersistence, and display_device::NoopSettingsPersistence.

---

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

• src/common/include/display_device/settings_persistence_interface.h