gpg:: SnapshotMetadata
#include <snapshot_metadata.h>
Pojedyncza struktura danych, która umożliwia dostęp do informacji o stanie określonych metadanych zrzutu.
Podsumowanie
W odróżnieniu od innych typów wartości właściwość SnapshotMetadata
nie jest stała. Interfejsy API SnapshotManager
mogą „zamknąć” zrzut, zmieniając wynik metody IsOpen(). Takie interfejsy API powszechnie wymagają, aby SnapshotMetadata
przekazany w IsOpen().
Konstruktorzy i niszczyciele |
|
---|---|
SnapshotMetadata()
|
|
SnapshotMetadata(std::shared_ptr< SnapshotMetadataImpl > impl)
|
|
SnapshotMetadata(const SnapshotMetadata & copy_from)
Tworzy kopię istniejącego obiektu
SnapshotMetadata . |
|
SnapshotMetadata(SnapshotMetadata && move_from)
Przenosi istniejący obiekt
SnapshotMetadata . |
|
~SnapshotMetadata()
|
Funkcje publiczne |
|
---|---|
CoverImageURL() const
|
const std::string &
Zwraca adres URL zdjęcia okładki.
|
Description() const
|
const std::string &
Zwraca zwięzły opis metadanych zrzutu.
|
FileName() const
|
const std::string &
Zwraca nazwę pliku i unikalny identyfikator zrzutu.
|
IsOpen() const
|
bool
Zwraca wartość „prawda”, gdy zwrócone metadane zrzutu zostały załadowane z pasującymi danymi pliku.
|
LastModifiedTime() const
|
Zwraca czas ostatniej modyfikacji wpisu (wyrażony w milisekundach od początku epoki uniksowej).
|
PlayedTime() const
|
Zwraca czas odtwarzania powiązany z metadanymi zrzutu.
|
ProgressValue() const
|
int64_t
Zwraca ustawioną wartość postępu powiązaną z metadanymi tego zrzutu.
|
Valid() const
|
bool
Zwraca wartość „true” (prawda), jeśli zwrócone metadane zrzutu są wypełnione danymi i towarzyszy mu stan pomyślnej odpowiedzi; wartość false (fałsz) w przypadku niewypełnionego zrzutu utworzonego przez użytkownika lub wypełnionego zrzutu, któremu towarzyszy niepowodzenie odpowiedzi.
|
operator=(const SnapshotMetadata & copy_from)
|
Przypisuje ten obiekt
SnapshotMetadata , kopiując go z innego. |
operator=(SnapshotMetadata && move_from)
|
Powoduje przypisanie tego obiektu
SnapshotMetadata , przenosząc do niego inny. |
Funkcje publiczne
CoverImageURL
const std::string & CoverImageURL() const
Zwraca adres URL zdjęcia okładki.
Opis
const std::string & Description() const
Zwraca zwięzły opis metadanych zrzutu.
Aby można było użyć tej funkcji, SnapshotMetadata::Valid()
musi zwracać wartość „prawda”.
FileName
const std::string & FileName() const
Zwraca nazwę pliku i unikalny identyfikator zrzutu.
Nazwy zrzutów muszą mieć od 1 do 100 znaków niezastrzeżonych w adresie URL (a–z, A–Z, 0–9 lub symboli „-”, „.”, „_” bądź „~”).
IsOpen
bool IsOpen() const
Zwraca wartość „prawda”, gdy zwrócone metadane zrzutu zostały załadowane z pasującymi danymi pliku.
Operacje związane z danymi, takie jak Read
, Commit
i Resolve
, będą działać tylko wtedy, gdy obiekt zawiera dane pliku. Mimo stałej wartości ta wartość zmienia się, aby odzwierciedlić dane bazowe metadanych zrzutu. Na przykład wywołanie Commit
w tej operacji sprawi, że IsOpen() zwróci wartość false;
LastModifiedTime
Timestamp LastModifiedTime() const
Zwraca czas ostatniej modyfikacji wpisu (wyrażony w milisekundach od początku epoki uniksowej).
ProgressValue
int64_t ProgressValue() const
Zwraca ustawioną wartość postępu powiązaną z metadanymi tego zrzutu.
Wartość postępu jest używana do automatycznego rozwiązywania konfliktów.
SnapshotMetadata
SnapshotMetadata()
SnapshotMetadata
SnapshotMetadata( std::shared_ptr< SnapshotMetadataImpl > impl )
Konstruuje obiekt SnapshotMetadata
z shared_ptr
na SnapshotMetadataImpl
.
Przeznaczona do użytku wewnętrznego przez interfejs API.
SnapshotMetadata
SnapshotMetadata( const SnapshotMetadata & copy_from )
Tworzy kopię istniejącego obiektu SnapshotMetadata
.
SnapshotMetadata
SnapshotMetadata( SnapshotMetadata && move_from )
Przenosi istniejący obiekt SnapshotMetadata
.
Prawidłowy
bool Valid() const
Zwraca wartość „true” (prawda), jeśli zwrócone metadane zrzutu są wypełnione danymi i towarzyszy mu stan pomyślnej odpowiedzi; wartość false (fałsz) w przypadku niewypełnionego zrzutu utworzonego przez użytkownika lub wypełnionego zrzutu, któremu towarzyszy niepowodzenie odpowiedzi.
Aby można było użyć tej funkcji, funkcja pobierająca (id
, Name
, Description
itd.) z tego zrzutu musi zwracać wartość „prawda”.
operator=
SnapshotMetadata & operator=( const SnapshotMetadata & copy_from )
Przypisuje ten obiekt SnapshotMetadata
, kopiując go z innego.
operator=
SnapshotMetadata & operator=( SnapshotMetadata && move_from )
Powoduje przypisanie tego obiektu SnapshotMetadata
, przenosząc do niego inny.
~SnapshotMetadata
~SnapshotMetadata()