gpg:: SnapshotMetadata
#include <snapshot_metadata.h>
一种数据结构,允许您访问有关特定快照元数据的状态数据。
摘要
与其他值类型不同,SnapshotMetadata
并非绝对不可变。SnapshotManager
API 可以“关闭”截取快照,更改 IsOpen() 方法的结果;此类 API 普遍要求在 IsOpen() 中传递的 SnapshotMetadata
。
构造函数和析构函数 |
|
---|---|
SnapshotMetadata()
|
|
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
|
|
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 才能使用此函数。
文件名
const std::string & FileName() const
返回快照的文件名和唯一标识符。
快照名称必须介于 1 到 100 个非网址预留字符(a-z、A-Z、0-9 或符号“-”“.”“_”或“~”)。
IsOpen
bool IsOpen() const
如果返回的快照元数据已加载了匹配的文件数据,则返回 true。
仅当对象包含文件数据时,与数据相关的操作(例如 Read
、Commit
和 Resolve
)才有效。尽管该值具有常量,但它会更改以反映快照元数据的底层数据。例如,对操作调用 Commit
会导致 IsOpen() 返回 false;
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
对象的副本。
有效
bool Valid() const
如果返回的快照元数据中填充了数据并同时显示成功响应状态,则返回 true;如果快照未填充用户创建的快照,或者已填充的快照响应失败,则为 false。
为了让此快照上的 getter 函数(id
、Name
、Description
等)可用,该函数必须返回 true。
operator=
SnapshotMetadata & operator=( const SnapshotMetadata & copy_from )
通过从另一个对象复制来分配此 SnapshotMetadata
对象。
operator=
SnapshotMetadata & operator=( SnapshotMetadata && move_from )
将另一个对象移到此 SnapshotMetadata
对象中,以分配该对象。
~SnapshotMetadata
~SnapshotMetadata()