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 对象。
operator=(SnapshotMetadata && move_from)
通过将另一个对象移入该对象来分配此 SnapshotMetadata 对象。

公共函数

CoverImageURL

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 等）可用。

运算符=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

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

运算符=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

通过将另一个对象移入该对象来分配此 SnapshotMetadata 对象。

~SnapshotMetadata

 ~SnapshotMetadata()