gpg::SnapshotMetadata

#include <snapshot_metadata.h>

一个单一数据结构，用于访问特定快照元数据的状态数据。

摘要

与其他值类型不同，SnapshotMetadata 并非严格不可变。SnapshotManager API 可以“关闭”快照，从而改变 IsOpen() 方法的结果；此类 API 通常要求传入的 SnapshotMetadata 是处于打开状态的 (即调用 IsOpen() 返回 true)。”

构造函数与析构函数
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
从 shared_ptr 到 SnapshotMetadataImpl 的共享指针构造一个 SnapshotMetadata 对象。
SnapshotMetadata(const SnapshotMetadata & copy_from)
创建现有 SnapshotMetadata 对象的副本。
SnapshotMetadata(SnapshotMetadata && move_from)
移动现有 SnapshotMetadata 对象。
~SnapshotMetadata()

公共函数
CoverImageURL() const
const std::string &
返回封面图片 URL。
Description() const
const std::string &
返回快照元数据的简洁描述。
FileName() const
const std::string &
返回快照的文件名和唯一标识符。
IsOpen() const
bool
当返回的快照元数据已加载匹配的文件数据时返回 true。
LastModifiedTime() const
返回条目上次修改的时间（表示为自 Unix 纪元以来的毫秒数）。
PlayedTime() const
返回与此快照元数据关联的游戏时间。
ProgressValue() const
int64_t
返回与此快照元数据关联的设置进度值。
Valid() const
bool
当返回的快照元数据填充了数据并伴随成功的响应状态时返回 true；对于未填充的用户创建快照或填充但伴随不成功响应状态的快照则返回 false。
operator=(const SnapshotMetadata & copy_from)
通过复制另一个 SnapshotMetadata 对象来赋值给此对象。
operator=(SnapshotMetadata && move_from)
通过移动另一个 SnapshotMetadata 对象到此对象来赋值。

公共函数

CoverImageURL

const std::string & CoverImageURL() const

返回封面图片 URL。

Description

const std::string & Description() const

返回快照元数据的简洁描述。

此函数可用之前，SnapshotMetadata::Valid() 必须返回 true。

FileName

const std::string & FileName() const

返回快照的文件名和唯一标识符。

快照名称必须包含 1 到 100 个非 URL 保留字符（a-z、A-Z、0-9 或符号“-”、“.”、“_”或“~”）。

IsOpen

bool IsOpen() const

当返回的快照元数据已加载匹配的文件数据时返回 true。

与数据相关的操作（例如 Read、Commit 和 Resolve）仅在对象具有文件数据时才起作用。尽管是 const，此值会随快照元数据的底层数据而改变。例如，对操作调用 Commit 会导致 IsOpen() 返回 false；

LastModifiedTime

Timestamp LastModifiedTime() const

返回条目上次修改的时间（表示为自 Unix 纪元以来的毫秒数）。

PlayedTime

gpg::Duration PlayedTime() const

返回与此快照元数据关联的游戏时间。

ProgressValue

int64_t ProgressValue() const

返回与此快照元数据关联的设置进度值。

进度值用于自动冲突解决。

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

从 shared_ptr 到 SnapshotMetadataImpl 的共享指针构造一个 SnapshotMetadata 对象。

供 API 内部使用。

SnapshotMetadata

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

创建现有 SnapshotMetadata 对象的副本。

SnapshotMetadata

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

移动现有 SnapshotMetadata 对象。

Valid

bool Valid() const

当返回的快照元数据填充了数据并伴随成功的响应状态时返回 true；对于未填充的用户创建快照或填充但伴随不成功响应状态的快照则返回 false。

此函数必须返回 true，此快照上的 getter 函数（id、Name、Description 等）才可用。

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

通过复制另一个 SnapshotMetadata 对象来赋值给此对象。

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

通过移动另一个 SnapshotMetadata 对象到此对象来赋值。

~SnapshotMetadata

 ~SnapshotMetadata()