模板类，表示数据库中的具体键 Template class representing a specific key in the database. More...

#include <interface.hpp>

Inheritance diagram for LibXR::Database::Key< Data >:

Collaboration diagram for LibXR::Database::Key< Data >:

Public Member Functions
	Key (Database &database, const char *name, Data init_value)
	构造函数，初始化键并从数据库加载数据 Constructor to initialize key and load data from the database.

	Key (Database &database, const char *name)
	构造函数，初始化键，并在数据库不存在时赋默认值 Constructor to initialize key, assigning default value if not found in the database.

	Key (const Key &other)=delete
	禁止拷贝数据库键对象 Copy construction is disabled for database keys.

	Key (Key &&other)=delete
	禁止移动数据库键对象 Move construction is disabled for database keys.

Key &	operator= (const Key &other)=delete
	禁止拷贝赋值数据库键对象 Copy assignment is disabled for database keys.

Key &	operator= (Key &&other)=delete
	禁止移动赋值数据库键对象 Move assignment is disabled for database keys.

	operator Data ()
	类型转换运算符，返回存储的数据 Type conversion operator returning stored data.

ErrorCode	Save ()
	保存当前键值到数据库 Save the current key value to the database.

ErrorCode	Set (Data data)
	设置键的值并更新数据库 Set the key's value and update the database.

ErrorCode	Load ()
	从数据库加载键的值 Load the key's value from the database.

ErrorCode	operator= (Data data)
	赋值运算符，设置键的值 Assignment operator to set the key's value.

Public Member Functions inherited from LibXR::Database::KeyBase
	KeyBase (const char *name, RawData raw_data)
	构造函数，初始化键名和原始数据 Constructor to initialize key name and raw data.

Public Attributes
Data	data_
	键存储的数据 / The data stored in the key.

Database &	database_
	关联的数据库对象 / Reference to the associated database.

Public Attributes inherited from LibXR::Database::KeyBase
const char *	name_
	键名 / Key name.

RawData	raw_data_
	原始数据 / Raw data associated with the key.

Detailed Description

template<typename Data>
class LibXR::Database::Key< Data >

模板类，表示数据库中的具体键 Template class representing a specific key in the database.

Template Parameters

Data	存储的数据类型 / The type of data stored.

Definition at line 51 of file interface.hpp.

Constructor & Destructor Documentation

◆ Key() [1/4]

template<typename Data >

LibXR::Database::Key< Data >::Key	(	Database &	database,
		const char *	name,
		Data	init_value )

inline

构造函数，初始化键并从数据库加载数据 Constructor to initialize key and load data from the database.

如果键在数据库中不存在，则使用提供的值进行初始化。 If the key does not exist in the database, it is initialized with the provided value.

Parameters

database	关联的数据库对象 / Reference to the associated database.
name	键名 / Key name.
init_value	初始化值 / Initial value for the key.

Definition at line 69 of file interface.hpp.

        : KeyBase(name, RawData(data_)), database_(database)
    {
      ErrorCode status = database.Get(*this);
      if (status != ErrorCode::OK)
      {
        data_ = init_value;
        if (status == ErrorCode::NOT_FOUND)
        {
          [[maybe_unused]] const auto add_result = database.Add(*this);
          REQUIRE(add_result == ErrorCode::OK);
        }
      }
    }

◆ Key() [2/4]

template<typename Data >

LibXR::Database::Key< Data >::Key	(	Database &	database,
		const char *	name )

inline

构造函数，初始化键，并在数据库不存在时赋默认值 Constructor to initialize key, assigning default value if not found in the database.

如果键在数据库中不存在，则初始化为零。 If the key does not exist in the database, it is initialized with zero.

Parameters

database	关联的数据库对象 / Reference to the associated database.
name	键名 / Key name.

Definition at line 95 of file interface.hpp.

        : KeyBase(name, RawData(data_)), database_(database)
    {
      ErrorCode status = database.Get(*this);
      if (status != ErrorCode::OK)
      {
        Memory::FastSet(&data_, 0, sizeof(Data));
        if (status == ErrorCode::NOT_FOUND)
        {
          [[maybe_unused]] const auto add_result = database.Add(*this);
          REQUIRE(add_result == ErrorCode::OK);
        }
      }
    }

◆ Key() [3/4]

template<typename Data >

LibXR::Database::Key< Data >::Key ( const Key< Data > & other )

delete

禁止拷贝数据库键对象 Copy construction is disabled for database keys.

Parameters

other 被拷贝的键对象 / Database key to copy from.

◆ Key() [4/4]

template<typename Data >

LibXR::Database::Key< Data >::Key ( Key< Data > && other )

delete

禁止移动数据库键对象 Move construction is disabled for database keys.

Parameters

other 被转移的键对象 / Database key to move from.

Member Function Documentation

◆ Load()

template<typename Data >

ErrorCode LibXR::Database::Key< Data >::Load ( )

inline

从数据库加载键的值 Load the key's value from the database.

Returns: 操作结果 / Operation result.

Definition at line 171 of file interface.hpp.

171{ return database_.Get(*this); }

◆ operator Data()

template<typename Data >

LibXR::Database::Key< Data >::operator Data ( )

inline

类型转换运算符，返回存储的数据 Type conversion operator returning stored data.

Returns: 存储的数据 / Stored data.

Definition at line 145 of file interface.hpp.

145{ return data_; }

◆ operator=() [1/3]

template<typename Data >

Key & LibXR::Database::Key< Data >::operator= ( const Key< Data > & other )

delete

禁止拷贝赋值数据库键对象 Copy assignment is disabled for database keys.

Parameters

other 被拷贝的键对象 / Database key to copy from.

Returns: 当前键对象引用 / Reference to the current key object.

◆ operator=() [2/3]

template<typename Data >

ErrorCode LibXR::Database::Key< Data >::operator= ( Data data )

inline

赋值运算符，设置键的值 Assignment operator to set the key's value.

Parameters

data	需要存储的新值 / New value to store.

Returns: 操作结果 / Operation result.

Definition at line 179 of file interface.hpp.

179{ return Set(data); } // NOLINT

LibXR::Database::Key::Set

ErrorCode Set(Data data)

设置键的值并更新数据库 Set the key's value and update the database.

Definition interface.hpp:160

◆ operator=() [3/3]

template<typename Data >

Key & LibXR::Database::Key< Data >::operator= ( Key< Data > && other )

delete

禁止移动赋值数据库键对象 Move assignment is disabled for database keys.

Parameters

other 被转移的键对象 / Database key to move from.

Returns: 当前键对象引用 / Reference to the current key object.

◆ Save()

template<typename Data >

ErrorCode LibXR::Database::Key< Data >::Save ( )

inline

保存当前键值到数据库 Save the current key value to the database.

Returns: 操作结果 / Operation result.

Definition at line 152 of file interface.hpp.

152{ return database_.Set(*this, this->raw_data_); }

LibXR::Database::KeyBase::raw_data_

RawData raw_data_

原始数据 / Raw data associated with the key.

Definition interface.hpp:34

◆ Set()

template<typename Data >

ErrorCode LibXR::Database::Key< Data >::Set ( Data data )

inline

设置键的值并更新数据库 Set the key's value and update the database.

Parameters

data	需要存储的新值 / New value to store.

Returns: 操作结果 / Operation result.

Definition at line 160 of file interface.hpp.

    {
      data_ = data;
      return Save();
    }

Member Data Documentation

◆ data_

template<typename Data >

Data LibXR::Database::Key< Data >::data_

键存储的数据 / The data stored in the key.

Definition at line 54 of file interface.hpp.

◆ database_

template<typename Data >

Database& LibXR::Database::Key< Data >::database_

关联的数据库对象 / Reference to the associated database.

Definition at line 55 of file interface.hpp.

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

src/middleware/database/interface.hpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Key() [1/4]

◆ Key() [2/4]

◆ Key() [3/4]

◆ Key() [4/4]

Member Function Documentation

◆ Load()

◆ operator Data()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ Save()

◆ Set()

Member Data Documentation

◆ data_

◆ database_