gpg::SnapshotMetadata

#include <snapshot_metadata.h>

一个数据结构，可让您访问有关特定快照元数据状态的数据。

摘要

与其他值类型不同，SnapshotMetadata 并非完全不可变。SnapshotManager API 可以“关闭”快照，从而更改 IsOpen() 方法的结果；此类 API 普遍要求在 IsOpen() 中传入 SnapshotMetadata。

构造函数和析构函数
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 &
返回封面图片网址。
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 对象复制来分配此 SnapshotMetadata 对象。
operator=(SnapshotMetadata && move_from)
通过将另一个 SnapshotMetadata 对象移入此 SnapshotMetadata 对象来对其进行赋值。

公共函数

CoverImage网址

const std::string & CoverImageURL() const

返回封面图片网址。

说明

const std::string & Description() const

返回快照元数据的简明说明。

SnapshotMetadata::Valid() 必须返回 true，此函数才能使用。

FileName

const std::string & FileName() const

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

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

IsOpen

bool IsOpen() const

如果已使用匹配的文件数据加载返回的快照元数据，则返回 true。

只有当对象包含文件数据时，数据相关操作（例如 Read、Commit 和 Resolve）才会起作用。尽管此值是常量，但它会发生变化，以反映快照元数据的基础数据。例如，对操作调用 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 对象。

有效

bool Valid() const

如果返回的快照元数据已填充数据且响应状态为成功，则返回 true；如果用户创建的快照未填充数据，或者已填充数据但响应状态为失败，则返回 false。

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

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

通过从另一个 SnapshotMetadata 对象复制来分配此 SnapshotMetadata 对象。

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

通过将另一个 SnapshotMetadata 对象移入此 SnapshotMetadata 对象来对其进行赋值。

~SnapshotMetadata

 ~SnapshotMetadata()