GFSaveDocumentReadResult¶
API Reference / Save / 类索引
- 路径：
addons/gf/extensions/save/document/gf_save_document_read_result.gd - 模块：
Save - 继承：
RefCounted - API：
public - 类别：值对象 (
value_object) - 首次版本：
9.0.0
存档文档读取终态结果。 结果保留物理存储读取、文档解析、schema 校验和迁移状态，避免调用方 把读取失败、格式损坏、未来版本或迁移缺口都误判为空 Dictionary。
成员概览¶
| 类型 | 名称 | 签名 |
|---|---|---|
| 常量 | STATUS_LOADED |
const STATUS_LOADED: StringName = &"loaded" |
| 常量 | STATUS_MIGRATED |
const STATUS_MIGRATED: StringName = &"migrated" |
| 常量 | STATUS_FAILED |
const STATUS_FAILED: StringName = &"failed" |
| 方法 | is_successful |
func is_successful() -> bool: |
| 方法 | was_migrated |
func was_migrated() -> bool: |
| 方法 | get_status |
func get_status() -> StringName: |
| 方法 | get_document |
func get_document() -> GFSaveDocument: |
| 方法 | get_storage_result |
func get_storage_result() -> GFStorageReadResult: |
| 方法 | get_migration_result |
func get_migration_result() -> GFSaveMigrationResult: |
| 方法 | get_validation_report |
func get_validation_report() -> Dictionary: |
| 方法 | get_error_code |
func get_error_code() -> Error: |
| 方法 | get_error |
func get_error() -> String: |
| 方法 | to_dict |
func to_dict() -> Dictionary: |
| 方法 | duplicate_result |
func duplicate_result() -> GFSaveDocumentReadResult: |
常量¶
STATUS_LOADED¶
- API：
public - 首次版本：
9.0.0
文档无需迁移并已加载。
STATUS_MIGRATED¶
- API：
public - 首次版本：
9.0.0
文档迁移后已加载。
STATUS_FAILED¶
- API：
public - 首次版本：
9.0.0
文档读取失败。
方法¶
is_successful¶
- API：
public - 首次版本：
9.0.0
检查读取、解析、迁移和最终校验是否全部成功。
返回：成功时返回 true。
was_migrated¶
- API：
public - 首次版本：
9.0.0
检查是否执行过迁移。
返回：migrated 状态返回 true。
get_status¶
- API：
public - 首次版本：
9.0.0
获取终态状态。
返回：loaded、migrated 或 failed。
get_document¶
- API：
public - 首次版本：
9.0.0
获取有效文档副本。
返回：成功文档；失败时返回 null。
get_storage_result¶
- API：
public - 首次版本：
9.0.0
获取底层存储读取结果副本。
返回：底层结果；尚未进入存储读取时可为 null。
get_migration_result¶
- API：
public - 首次版本：
9.0.0
获取迁移结果副本。
返回：运行过迁移注册表时的结果，否则为 null。
get_validation_report¶
- API：
public - 首次版本：
9.0.0
获取最终校验报告副本。
返回：文档或目标 schema 校验报告。
结构：
return: GFValidationReportDictionary-compatible report.
get_error_code¶
- API：
public - 首次版本：
9.0.0
获取错误码。
返回：Godot Error 码。
get_error¶
- API：
public - 首次版本：
9.0.0
获取错误说明。
返回：失败说明。
to_dict¶
- API：
public - 首次版本：
9.0.0
转换为诊断字典。
返回：读取结果摘要。
结构：
return: Dictionary with ok, status, error_code, error, migrated, document, storage_result, migration_result, and validation_report.
duplicate_result¶
- API：
public - 首次版本：
9.0.0
创建结果副本。
返回：隔离结果。