Store all the tables of the database. More...

#include <settings/Database.h>

Inheritance diagram for settings::Database:

[legend]

Collaboration diagram for settings::Database:

Public Member Functions
bool	is_valid (id_of_settings id) const

container_of_settings	get_settings_table () const

id_of_settings	next (id_of_settings id) const

id_of_settings	previous (id_of_settings id) const

template<class Comparator >
std::vector< id_of_settings >	sorted_settings (Comparator comparator) const

bool	get_dark_mode (id_of_settings record=id_of_settings{0}) const

const std::string &	get_host (id_of_settings record=id_of_settings{0}) const

const std::string &	get_user (id_of_settings record=id_of_settings{0}) const

Static Public Member Functions
template<typename E = joedb::Exception>
static void	throw_exception (const std::string &message)

static id_of_settings	null_settings ()

static constexpr id_of_settings	the_settings ()

Protected Member Functions
bool	is_valid_record_id_for_settings (Record_Id record_id) const

void	internal_delete_settings (Record_Id record_id)

void	internal_insert_settings (Record_Id record_id)

void	internal_vector_insert_settings (Record_Id record_id, size_t size)

void	internal_update_settings__dark_mode (Record_Id record_id, bool field_value_of_dark_mode)

void	internal_update_vector_settings__dark_mode (Record_Id record_id, size_t size, const char *value)

void	internal_update_settings__host (Record_Id record_id, const std::string &field_value_of_host)

void	internal_update_vector_settings__host (Record_Id record_id, size_t size, const std::string *value)

void	internal_update_settings__user (Record_Id record_id, const std::string &field_value_of_user)

void	internal_update_vector_settings__user (Record_Id record_id, size_t size, const std::string *value)

Protected Attributes
detail::data_of_settings	storage_of_settings

Friends
class	Readable

class	id_of_settings

class	container_of_settings

Detailed Description

Definition at line 67 of file Database.h.

Member Function Documentation

◆ get_dark_mode()

bool settings::Database::get_dark_mode ( id_of_settings record = id_of_settings{0} ) const

inline

Definition at line 206 of file Database.h.

◆ get_host()

const std::string & settings::Database::get_host ( id_of_settings record = id_of_settings{0} ) const

inline

Definition at line 212 of file Database.h.

◆ get_settings_table()

container_of_settings settings::Database::get_settings_table ( ) const

inline

Definition at line 268 of file Database.h.

◆ get_user()

const std::string & settings::Database::get_user ( id_of_settings record = id_of_settings{0} ) const

inline

Definition at line 218 of file Database.h.

◆ internal_delete_settings()

void settings::Database::internal_delete_settings ( Record_Id record_id )

inlineprotected

Definition at line 86 of file Database.h.

◆ internal_insert_settings()

void settings::Database::internal_insert_settings ( Record_Id record_id )

inlineprotected

Definition at line 95 of file Database.h.

◆ internal_update_settings__dark_mode()

void settings::Database::internal_update_settings__dark_mode	(	Record_Id	record_id,
		bool	field_value_of_dark_mode
	)

inlineprotected

Definition at line 106 of file Database.h.

◆ internal_update_settings__host()

void settings::Database::internal_update_settings__host	(	Record_Id	record_id,
		const std::string &	field_value_of_host
	)

inlineprotected

Definition at line 129 of file Database.h.

◆ internal_update_settings__user()

void settings::Database::internal_update_settings__user	(	Record_Id	record_id,
		const std::string &	field_value_of_user
	)

inlineprotected

Definition at line 152 of file Database.h.

◆ internal_update_vector_settings__dark_mode()

void settings::Database::internal_update_vector_settings__dark_mode	(	Record_Id	record_id,
		size_t	size,
		const char *	value
	)

inlineprotected

Definition at line 116 of file Database.h.

◆ internal_update_vector_settings__host()

void settings::Database::internal_update_vector_settings__host	(	Record_Id	record_id,
		size_t	size,
		const std::string *	value
	)

inlineprotected

Definition at line 139 of file Database.h.

◆ internal_update_vector_settings__user()

void settings::Database::internal_update_vector_settings__user	(	Record_Id	record_id,
		size_t	size,
		const std::string *	value
	)

inlineprotected

Definition at line 162 of file Database.h.

◆ internal_vector_insert_settings()

void settings::Database::internal_vector_insert_settings	(	Record_Id	record_id,
		size_t	size
	)

inlineprotected

Definition at line 100 of file Database.h.

◆ is_valid()

bool settings::Database::is_valid ( id_of_settings id ) const

inline

Definition at line 80 of file Database.h.

◆ is_valid_record_id_for_settings()

bool settings::Database::is_valid_record_id_for_settings ( Record_Id record_id ) const

inlineprotected

Definition at line 84 of file Database.h.

◆ next()

id_of_settings settings::Database::next ( id_of_settings id ) const

inline

Definition at line 178 of file Database.h.

◆ null_settings()

static id_of_settings settings::Database::null_settings ( )

inlinestatic

Definition at line 197 of file Database.h.

◆ previous()

id_of_settings settings::Database::previous ( id_of_settings id ) const

inline

Definition at line 186 of file Database.h.

◆ sorted_settings()

template<class Comparator >

std::vector< id_of_settings > settings::Database::sorted_settings ( Comparator comparator ) const

Definition at line 274 of file Database.h.

◆ the_settings()

static constexpr id_of_settings settings::Database::the_settings ( )

inlinestaticconstexpr

Definition at line 201 of file Database.h.

◆ throw_exception()

template<typename E = joedb::Exception>

static void settings::Database::throw_exception ( const std::string & message )

inlinestatic

Definition at line 75 of file Database.h.

Friends And Related Symbol Documentation

◆ container_of_settings

friend class container_of_settings

friend

Definition at line 71 of file Database.h.

◆ id_of_settings

friend class id_of_settings

friend

Definition at line 70 of file Database.h.

◆ Readable

friend class Readable

friend

Definition at line 69 of file Database.h.

Member Data Documentation

◆ storage_of_settings

detail::data_of_settings settings::Database::storage_of_settings

protected

Definition at line 83 of file Database.h.

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

/home/rcoulom/repos/joedb/doc/source/tutorial/src/settings/Database.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Function Documentation

◆ get_dark_mode()

◆ get_host()

◆ get_settings_table()

◆ get_user()

◆ internal_delete_settings()

◆ internal_insert_settings()

◆ internal_update_settings__dark_mode()

◆ internal_update_settings__host()

◆ internal_update_settings__user()

◆ internal_update_vector_settings__dark_mode()

◆ internal_update_vector_settings__host()

◆ internal_update_vector_settings__user()

◆ internal_vector_insert_settings()

◆ is_valid()

◆ is_valid_record_id_for_settings()

◆ next()

◆ null_settings()

◆ previous()

◆ sorted_settings()

◆ the_settings()

◆ throw_exception()

Friends And Related Symbol Documentation

◆ container_of_settings

◆ id_of_settings

◆ Readable

Member Data Documentation

◆ storage_of_settings