gpg::SnapshotMetadata

#include <snapshot_metadata.h>

一个允许您访问特定快照元数据状态的数据结构。

摘要

与其他值类型不同，SnapshotMetadata 不是严格不变的。 SnapshotManager API 可以“关闭”快照，从而更改 IsOpen() 方法的结果；此类 API 通常要求在 IsOpen() 中传入 SnapshotMetadata。

构造函数和析构函数
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
从指向 SnapshotMetadataImpl 的 shared_ptr 构造 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
)

从指向 SnapshotMetadataImpl 的 shared_ptr 构造 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()