LibXR::DatabaseRaw< MinWriteSize >::KeyInfo Struct Reference

键信息结构，存储键的元数据 (Structure containing key metadata). More...

Collaboration diagram for LibXR::DatabaseRaw< MinWriteSize >::KeyInfo:

Public Member Functions
	KeyInfo ()
	构造一个默认可写的键头元数据 (Construct one default writable key-header metadata object).
void	SetNameLength (uint8_t len)
	设置键名长度 (Set the key name length).
uint8_t	GetNameLength () const
	获取键名长度 (Get the key name length).
void	SetDataSize (uint32_t size)
	设置数据字节数 (Set the payload size in bytes).
uint32_t	GetDataSize () const
	获取数据字节数 (Get the payload size in bytes).

Data Fields
BlockBoolData< MinWriteSize >	no_next_key
	是否是最后一个键
BlockBoolData< MinWriteSize >	available_flag
	该键是否有效
BlockBoolData< MinWriteSize >	uninit
	该键是否未初始化
uint32_t	raw_info

Detailed Description

template<size_t MinWriteSize>
struct LibXR::DatabaseRaw< MinWriteSize >::KeyInfo

键信息结构，存储键的元数据 (Structure containing key metadata).

Definition at line 106 of file raw.hpp.

Constructor & Destructor Documentation

KeyInfo()

template<size_t MinWriteSize>

LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::KeyInfo ( )

inline

构造一个默认可写的键头元数据 (Construct one default writable key-header metadata object).

Definition at line 120 of file raw.hpp.

{
 
template <size_t MinWriteSize>
class DatabaseRaw : public Database
{
  static constexpr uint32_t FLASH_HEADER = 0x12345678 + LIBXR_DATABASE_VERSION;
 
  static constexpr uint32_t CHECKSUM_BYTE = 0x9abcedf0;
 
  // 存储布局定义：块角色、位图编码、键头与块头。
  // Storage layout definitions: block roles, bitmap encodings, key headers,
  // and block headers.
#include "layout.hpp"
 
  size_t recycle_threshold_ = 0;
 
  Flash& flash_;
 
  uint32_t block_size_;
 
  uint8_t write_buffer_[MinWriteSize];
 
  // 底层 Flash 读写辅助：按最小写入单元对齐、补齐、复制。
  // Low-level Flash I/O helpers: minimum-write-unit alignment, tail padding,
  // and raw copying.
#include "flash_io.hpp"
 
  // 块级语义：初始化、校验、失效、已用空间计算和块间复制。
  // Block-level semantics: initialization, validation, invalidation,
  // used-space accounting, and block-to-block copying.
#include "block_ops.hpp"
 
  // 键级语义：查找、追加、逻辑更新、条目地址计算。
  // Key-level semantics: lookup, append, logical replacement, and entry
  // address calculations.
#include "key_ops.hpp"
 
 public:
  // 对外生命周期与主流程：构造、初始化、读写、恢复、回收。
  // Public lifecycle and main flow: construction, initialization, read/write,
  // restore, and recycle.
#include "lifecycle.hpp"
};
 
}  // namespace LibXR

Member Function Documentation

GetDataSize()

template<size_t MinWriteSize>

uint32_t LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::GetDataSize ( ) const

inline

获取数据字节数 (Get the payload size in bytes).

Returns

数据字节数 (Payload size in bytes).

Definition at line 155 of file raw.hpp.

{
 
template <size_t MinWriteSize>
class DatabaseRaw : public Database
{
  static constexpr uint32_t FLASH_HEADER = 0x12345678 + LIBXR_DATABASE_VERSION;
 
  static constexpr uint32_t CHECKSUM_BYTE = 0x9abcedf0;
 
  // 存储布局定义：块角色、位图编码、键头与块头。
  // Storage layout definitions: block roles, bitmap encodings, key headers,
  // and block headers.
#include "layout.hpp"
 
  size_t recycle_threshold_ = 0;
 
  Flash& flash_;
 
  uint32_t block_size_;
 
  uint8_t write_buffer_[MinWriteSize];
 
  // 底层 Flash 读写辅助：按最小写入单元对齐、补齐、复制。
  // Low-level Flash I/O helpers: minimum-write-unit alignment, tail padding,
  // and raw copying.
#include "flash_io.hpp"
 
  // 块级语义：初始化、校验、失效、已用空间计算和块间复制。
  // Block-level semantics: initialization, validation, invalidation,
  // used-space accounting, and block-to-block copying.
#include "block_ops.hpp"
 
  // 键级语义：查找、追加、逻辑更新、条目地址计算。
  // Key-level semantics: lookup, append, logical replacement, and entry
  // address calculations.
#include "key_ops.hpp"
 
 public:
  // 对外生命周期与主流程：构造、初始化、读写、恢复、回收。
  // Public lifecycle and main flow: construction, initialization, read/write,
  // restore, and recycle.
#include "lifecycle.hpp"
};
 
}  // namespace LibXR

GetNameLength()

template<size_t MinWriteSize>

uint8_t LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::GetNameLength ( ) const

inline

获取键名长度 (Get the key name length).

Returns

键名长度 (Key name length).

Definition at line 140 of file raw.hpp.

{
 
template <size_t MinWriteSize>
class DatabaseRaw : public Database
{
  static constexpr uint32_t FLASH_HEADER = 0x12345678 + LIBXR_DATABASE_VERSION;
 
  static constexpr uint32_t CHECKSUM_BYTE = 0x9abcedf0;
 
  // 存储布局定义：块角色、位图编码、键头与块头。
  // Storage layout definitions: block roles, bitmap encodings, key headers,
  // and block headers.
#include "layout.hpp"
 
  size_t recycle_threshold_ = 0;
 
  Flash& flash_;
 
  uint32_t block_size_;
 
  uint8_t write_buffer_[MinWriteSize];
 
  // 底层 Flash 读写辅助：按最小写入单元对齐、补齐、复制。
  // Low-level Flash I/O helpers: minimum-write-unit alignment, tail padding,
  // and raw copying.
#include "flash_io.hpp"
 
  // 块级语义：初始化、校验、失效、已用空间计算和块间复制。
  // Block-level semantics: initialization, validation, invalidation,
  // used-space accounting, and block-to-block copying.
#include "block_ops.hpp"
 
  // 键级语义：查找、追加、逻辑更新、条目地址计算。
  // Key-level semantics: lookup, append, logical replacement, and entry
  // address calculations.
#include "key_ops.hpp"
 
 public:
  // 对外生命周期与主流程：构造、初始化、读写、恢复、回收。
  // Public lifecycle and main flow: construction, initialization, read/write,
  // restore, and recycle.
#include "lifecycle.hpp"
};
 
}  // namespace LibXR

SetDataSize()

template<size_t MinWriteSize>

void LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::SetDataSize ( uint32_t size )

inline

设置数据字节数 (Set the payload size in bytes).

Parameters

size	数据字节数 (Payload size in bytes).

Definition at line 146 of file raw.hpp.

{
 
template <size_t MinWriteSize>
class DatabaseRaw : public Database
{
  static constexpr uint32_t FLASH_HEADER = 0x12345678 + LIBXR_DATABASE_VERSION;
 
  static constexpr uint32_t CHECKSUM_BYTE = 0x9abcedf0;
 
  // 存储布局定义：块角色、位图编码、键头与块头。
  // Storage layout definitions: block roles, bitmap encodings, key headers,
  // and block headers.
#include "layout.hpp"
 
  size_t recycle_threshold_ = 0;
 
  Flash& flash_;
 
  uint32_t block_size_;
 
  uint8_t write_buffer_[MinWriteSize];
 
  // 底层 Flash 读写辅助：按最小写入单元对齐、补齐、复制。
  // Low-level Flash I/O helpers: minimum-write-unit alignment, tail padding,
  // and raw copying.
#include "flash_io.hpp"
 
  // 块级语义：初始化、校验、失效、已用空间计算和块间复制。
  // Block-level semantics: initialization, validation, invalidation,
  // used-space accounting, and block-to-block copying.
#include "block_ops.hpp"
 
  // 键级语义：查找、追加、逻辑更新、条目地址计算。
  // Key-level semantics: lookup, append, logical replacement, and entry
  // address calculations.
#include "key_ops.hpp"
 
 public:
  // 对外生命周期与主流程：构造、初始化、读写、恢复、回收。
  // Public lifecycle and main flow: construction, initialization, read/write,
  // restore, and recycle.
#include "lifecycle.hpp"
};
 
}  // namespace LibXR

SetNameLength()

template<size_t MinWriteSize>

void LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::SetNameLength ( uint8_t len )

inline

设置键名长度 (Set the key name length).

Parameters

len	键名长度 (Key name length).

Definition at line 131 of file raw.hpp.

{
 
template <size_t MinWriteSize>
class DatabaseRaw : public Database
{
  static constexpr uint32_t FLASH_HEADER = 0x12345678 + LIBXR_DATABASE_VERSION;
 
  static constexpr uint32_t CHECKSUM_BYTE = 0x9abcedf0;
 
  // 存储布局定义：块角色、位图编码、键头与块头。
  // Storage layout definitions: block roles, bitmap encodings, key headers,
  // and block headers.
#include "layout.hpp"
 
  size_t recycle_threshold_ = 0;
 
  Flash& flash_;
 
  uint32_t block_size_;
 
  uint8_t write_buffer_[MinWriteSize];
 
  // 底层 Flash 读写辅助：按最小写入单元对齐、补齐、复制。
  // Low-level Flash I/O helpers: minimum-write-unit alignment, tail padding,
  // and raw copying.
#include "flash_io.hpp"
 
  // 块级语义：初始化、校验、失效、已用空间计算和块间复制。
  // Block-level semantics: initialization, validation, invalidation,
  // used-space accounting, and block-to-block copying.
#include "block_ops.hpp"
 
  // 键级语义：查找、追加、逻辑更新、条目地址计算。
  // Key-level semantics: lookup, append, logical replacement, and entry
  // address calculations.
#include "key_ops.hpp"
 
 public:
  // 对外生命周期与主流程：构造、初始化、读写、恢复、回收。
  // Public lifecycle and main flow: construction, initialization, read/write,
  // restore, and recycle.
#include "lifecycle.hpp"
};
 
}  // namespace LibXR

Field Documentation

available_flag

template<size_t MinWriteSize>

BlockBoolData<MinWriteSize> LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::available_flag

该键是否有效

Definition at line 109 of file raw.hpp.

no_next_key

template<size_t MinWriteSize>

BlockBoolData<MinWriteSize> LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::no_next_key

是否是最后一个键

Definition at line 108 of file raw.hpp.

raw_info

template<size_t MinWriteSize>

uint32_t LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::raw_info

Initial value:

=
      0

高 7 位保存 nameLength，低 25 位保存 dataSize。 Upper 7 bits store nameLength and lower 25 bits store dataSize.

Definition at line 112 of file raw.hpp.

uninit

template<size_t MinWriteSize>

BlockBoolData<MinWriteSize> LibXR::DatabaseRaw< MinWriteSize >::KeyInfo::uninit

该键是否未初始化

Definition at line 110 of file raw.hpp.

---

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

• src/middleware/database/raw/raw.hpp