display_device::FileSettingsPersistence Class Reference

Implementation of the SettingsPersistenceInterface, that saves/loads the persistent settings to/from the file. More...

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

Inheritance diagram for display_device::FileSettingsPersistence:

Collaboration diagram for display_device::FileSettingsPersistence:

Public Member Functions
bool	clear () override
	Clear the persistent settings data.
	FileSettingsPersistence (std::filesystem::path filepath)
std::optional< std::vector< std::uint8_t > >	load () const override
	Load saved settings data.
bool	store (const std::vector< std::uint8_t > &data) override
	Store the provided data.
Public Member Functions inherited from display_device::SettingsPersistenceInterface
virtual	~SettingsPersistenceInterface ()=default
	Default virtual destructor.

Detailed Description

Implementation of the SettingsPersistenceInterface, that saves/loads the persistent settings to/from the file.

Constructor & Destructor Documentation

FileSettingsPersistence()

display_device::FileSettingsPersistence::FileSettingsPersistence ( std::filesystem::path filepath )

explicit

Default constructor. Does not perform any operations on the file yet.

Parameters

filepath

A non-empty filepath. Throws on empty.

Member Function Documentation

clear()

bool display_device::FileSettingsPersistence::clear ( )

nodiscardoverridevirtual

Clear the persistent settings data.

Returns

True if data was cleared, false otherwise.

*Examples**

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

Implements display_device::SettingsPersistenceInterface.

load()

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

nodiscardoverridevirtual

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();

Note

If file does not exist, an empty data list will be returned instead of null optional.

If the path exists but is not a regular file, null optional will be returned.

Implements display_device::SettingsPersistenceInterface.

store()

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

nodiscardoverridevirtual

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);

Warning

The method does not create missing directories!

Implements display_device::SettingsPersistenceInterface.

---

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

• src/common/include/display_device/file_settings_persistence.h
• src/common/file_settings_persistence.cpp