GFStorageReadResult¶
API Reference / Standard / 类索引
- 路径：
addons/gf/standard/utilities/storage/gf_storage_read_result.gd - 模块：
Standard - 继承：
RefCounted - API：
public - 类别：值对象 (
value_object) - 首次版本：
9.0.0
严格存储读取结果。 将业务载荷、框架存储元数据、完整性状态和失败原因分离，避免调用方 把空字典误判为成功，也避免存储层保留字段渗入业务数据。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 枚举 | IntegrityStatus |
enum IntegrityStatus |
| 属性 | ok |
var ok: bool = false |
| 属性 | payload |
var payload: Dictionary = {} |
| 属性 | metadata |
var metadata: Dictionary = {} |
| 属性 | integrity_status |
var integrity_status: IntegrityStatus = IntegrityStatus.NOT_CHECKED |
| 属性 | error_code |
var error_code: Error = OK |
| 属性 | error |
var error: String = "" |
| 属性 | document_schema_version |
var document_schema_version: int = 0 |
| 属性 | source_data_version |
var source_data_version: int = 0 |
| 属性 | data_version |
var data_version: int = 0 |
| 属性 | migrated |
var migrated: bool = false |
| 方法 | configure_success |
func configure_success( p_payload: Dictionary, p_metadata: Dictionary = {}, p_integrity_status: IntegrityStatus = IntegrityStatus.NOT_CHECKED, p_document_schema_version: int = 0 ) -> GFStorageReadResult: |
| 方法 | configure_failure |
func configure_failure( p_error: String, p_error_code: Error = ERR_INVALID_DATA, p_metadata: Dictionary = {}, p_integrity_status: IntegrityStatus = IntegrityStatus.NOT_CHECKED, p_document_schema_version: int = 0 ) -> GFStorageReadResult: |
| 方法 | is_integrity_accepted |
func is_integrity_accepted() -> bool: |
| 方法 | duplicate_result |
func duplicate_result() -> GFStorageReadResult: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | apply_dict |
func apply_dict(data: Dictionary) -> void: |
| 方法 | from_dict |
static func from_dict(data: Dictionary) -> GFStorageReadResult: |
枚举¶
IntegrityStatus¶
- API：
public - 首次版本：
9.0.0
enum IntegrityStatus {
## 文档没有声明完整性校验，且调用方没有要求校验。
NOT_CHECKED,
## 文档完整性校验通过。
VALID,
## 调用方要求完整性校验，但文档没有校验信息。
MISSING,
## 文档完整性校验失败。
INVALID,
}
存储文档完整性状态。
属性¶
ok¶
- API：
public - 首次版本：
9.0.0
读取、解码和迁移是否全部成功。
payload¶
- API：
public - 首次版本：
9.0.0
与框架存储字段完全隔离的业务载荷。
结构：
payload: Dictionary，项目写入的原始业务数据。
metadata¶
- API：
public - 首次版本：
9.0.0
框架存储文档元数据。
结构：
metadata: Dictionary，包含 data_version 以及可选时间戳、格式和压缩信息。
integrity_status¶
- API：
public - 首次版本：
9.0.0
完整性校验状态。
error_code¶
- API：
public - 首次版本：
9.0.0
Godot 错误码；成功时为 OK。
error¶
- API：
public - 首次版本：
9.0.0
稳定、可展示的错误描述；成功时为空字符串。
document_schema_version¶
- API：
public - 首次版本：
9.0.0
物理存储文档 schema 版本。
source_data_version¶
- API：
public - 首次版本：
9.0.0
读取时发现的数据 schema 版本。
data_version¶
- API：
public - 首次版本：
9.0.0
完成迁移后的数据 schema 版本。
migrated¶
- API：
public - 首次版本：
9.0.0
本次读取是否执行过数据迁移。
方法¶
configure_success¶
- API：
public - 首次版本：
9.0.0
func configure_success( p_payload: Dictionary, p_metadata: Dictionary = {}, p_integrity_status: IntegrityStatus = IntegrityStatus.NOT_CHECKED, p_document_schema_version: int = 0 ) -> GFStorageReadResult:
配置成功结果。
参数：
| 名称 | 说明 |
|---|---|
p_payload |
业务载荷。 |
p_metadata |
框架存储元数据。 |
p_integrity_status |
完整性状态。 |
p_document_schema_version |
物理文档 schema 版本。 |
返回：当前结果。
结构：
p_payload: Dictionary，项目写入的业务数据。p_metadata: Dictionary，框架存储元数据。
configure_failure¶
- API：
public - 首次版本：
9.0.0
func configure_failure( p_error: String, p_error_code: Error = ERR_INVALID_DATA, p_metadata: Dictionary = {}, p_integrity_status: IntegrityStatus = IntegrityStatus.NOT_CHECKED, p_document_schema_version: int = 0 ) -> GFStorageReadResult:
配置失败结果。
参数：
| 名称 | 说明 |
|---|---|
p_error |
错误描述。 |
p_error_code |
Godot 错误码。 |
p_metadata |
已能安全恢复的框架存储元数据。 |
p_integrity_status |
完整性状态。 |
p_document_schema_version |
物理文档 schema 版本。 |
返回：当前结果。
结构：
p_metadata: Dictionary，失败时仍可安全展示或诊断的框架存储元数据。
is_integrity_accepted¶
- API：
public - 首次版本：
9.0.0
完整性状态是否允许调用方使用载荷。
返回：状态不是 MISSING 或 INVALID 时返回 true。
duplicate_result¶
- API：
public - 首次版本：
9.0.0
创建读取结果深拷贝。
返回：新读取结果。
to_dict¶
- API：
public - 首次版本：
9.0.0
转换为线程、报告和工具可传递的字典。
返回：读取结果字典。
结构：
return: Dictionary，包含 ok、payload、metadata、integrity_status、error_code、error、document_schema_version、source_data_version、data_version 和 migrated。
apply_dict¶
- API：
public - 首次版本：
9.0.0
从字典应用读取结果字段。
参数：
| 名称 | 说明 |
|---|---|
data |
读取结果字典。 |
结构：
data: Dictionary，GFStorageReadResult.to_dict() 输出。
from_dict¶
- API：
public - 首次版本：
9.0.0
从字典创建读取结果。
参数：
| 名称 | 说明 |
|---|---|
data |
读取结果字典。 |
返回：新读取结果。
结构：
data: Dictionary，GFStorageReadResult.to_dict() 输出。