gpg::SnapshotMetadata

#include <snapshot_metadata.h>

Uma única estrutura de dados que permite acessar dados sobre o status de metadados de um snapshot específico.

Resumo

Ao contrário de outros tipos de valor, um SnapshotMetadata não é estritamente imutável. As APIs SnapshotManager podem "fechar" o snapshot, mudando o resultado do método IsOpen(). Essas APIs exigem universalmente que o SnapshotMetadata seja transmitido em IsOpen().

Construtores e destrutores
SnapshotMetadata()
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
Cria um objeto SnapshotMetadata de um shared_ptr para um SnapshotMetadataImpl.
SnapshotMetadata(const SnapshotMetadata & copy_from)
Cria uma cópia de um objeto SnapshotMetadata.
SnapshotMetadata(SnapshotMetadata && move_from)
Move um objeto SnapshotMetadata.
~SnapshotMetadata()

Funções públicas
CoverImageURL() const
const std::string &
Retorna o URL da imagem de capa.
Description() const
const std::string &
Retorna uma descrição concisa dos metadados do snapshot.
FileName() const
const std::string &
Retorna o nome do arquivo e o identificador exclusivo do snapshot.
IsOpen() const
bool
Retorna "true" quando os metadados do snapshot retornado são carregados com dados de arquivo correspondentes.
LastModifiedTime() const
Retorna a hora em que a entrada foi modificada pela última vez (expressa em milissegundos desde a época Unix).
PlayedTime() const
Retorna o tempo de reprodução associado aos metadados do snapshot.
ProgressValue() const
int64_t
Retorna o valor de progresso definido associado aos metadados do snapshot.
Valid() const
bool
Retorna "true" quando os metadados do snapshot retornado são preenchidos com dados e acompanhados de um status de resposta bem-sucedido. Retorna "false" para um snapshot criado pelo usuário sem preenchimento ou para um preenchido acompanhado de um status de resposta com falha.
operator=(const SnapshotMetadata & copy_from)
Atribui esse objeto SnapshotMetadata copiando de outro.
operator=(SnapshotMetadata && move_from)
Atribui esse objeto SnapshotMetadata movendo outro para ele.

Funções públicas

CoverImageURL

const std::string & CoverImageURL() const

Retorna o URL da imagem de capa.

Descrição

const std::string & Description() const

Retorna uma descrição concisa dos metadados do snapshot.

SnapshotMetadata::Valid() precisa retornar "true" para que essa função seja utilizável.

FileName

const std::string & FileName() const

Retorna o nome do arquivo e o identificador exclusivo do snapshot.

Os nomes dos snapshots precisam ter entre 1 e 100 caracteres não reservados para URL (a-z, A-Z, 0-9 ou os símbolos "-", ".", "_" ou "~").

IsOpen

bool IsOpen() const

Retorna "true" quando os metadados do snapshot retornado são carregados com dados de arquivo correspondentes.

Operações relacionadas a dados, como Read, Commit e Resolve, só vão funcionar se o objeto tiver dados de arquivo. Apesar de ser const, esse valor muda para refletir os dados subjacentes dos metadados do snapshot. Por exemplo, chamar Commit na operação fará com que IsOpen() retorne falso.

LastModifiedTime

Timestamp LastModifiedTime() const

Retorna a hora em que a entrada foi modificada pela última vez (expressa em milissegundos desde a época Unix).

PlayedTime

gpg::Duration PlayedTime() const

Retorna o tempo de reprodução associado aos metadados do snapshot.

ProgressValue

int64_t ProgressValue() const

Retorna o valor de progresso definido associado aos metadados do snapshot.

O valor de progresso é usado na resolução automática de conflitos.

SnapshotMetadata

 SnapshotMetadata()

SnapshotMetadata

 SnapshotMetadata(
  std::shared_ptr< SnapshotMetadataImpl > impl
)

Cria um objeto SnapshotMetadata de um shared_ptr para um SnapshotMetadataImpl.

Destinado a uso interno pela API.

SnapshotMetadata

 SnapshotMetadata(
  const SnapshotMetadata & copy_from
)

Cria uma cópia de um objeto SnapshotMetadata.

SnapshotMetadata

 SnapshotMetadata(
  SnapshotMetadata && move_from
)

Move um objeto SnapshotMetadata.

Válido

bool Valid() const

Retorna "true" quando os metadados do snapshot retornado são preenchidos com dados e acompanhados de um status de resposta bem-sucedido. Retorna "false" para um snapshot criado pelo usuário sem preenchimento ou para um preenchido acompanhado de um status de resposta com falha.

Essa função precisa retornar "true" para que as funções de getter (id, Name, Description etc.) sejam utilizáveis.

operator=

SnapshotMetadata & operator=(
  const SnapshotMetadata & copy_from
)

Atribui esse objeto SnapshotMetadata copiando de outro.

operator=

SnapshotMetadata & operator=(
  SnapshotMetadata && move_from
)

Atribui esse objeto SnapshotMetadata movendo outro para ele.

~SnapshotMetadata

 ~SnapshotMetadata()