Struct SnapshotFile 

pub struct SnapshotFile {

    pub time: Zoned,
    pub program_version: String,
    pub parent: Option<SnapshotId>,
    pub parents: Vec<SnapshotId>,
    pub tree: TreeId,
    pub label: String,
    pub paths: StringList,
    pub hostname: String,
    pub username: String,
    pub uid: u32,
    pub gid: u32,
    pub tags: StringList,
    pub original: Option<SnapshotId>,
    pub delete: DeleteOption,
    pub summary: Option<SnapshotSummary>,
    pub description: Option<String>,
    pub id: SnapshotId,
}

A SnapshotFile is the repository representation of the snapshot metadata saved in a repository.

It is usually saved in the repository under snapshot/<ID>

Note

SnapshotFile implements Eq, PartialEq, Ord, PartialOrd by comparing only the time field. If you need another ordering, you have to implement that yourself.

Fields

time: Zoned

Timestamp of this snapshot

program_version: String

Program identifier and its version that have been used to create this snapshot.

parent: Option<SnapshotId>

The Id of the first parent snapshot that this snapshot has been based on

parents: Vec<SnapshotId>

The Ids of all parent snapshots that this snapshot has been based on

tree: TreeId

The tree blob id where the contents of this snapshot are stored

label: String

Label for the snapshot

paths: StringList

The list of paths contained in this snapshot

hostname: String

The hostname of the device on which the snapshot has been created

username: String

The username that started the backup run

uid: u32

The uid of the username that started the backup run

gid: u32

The gid of the username that started the backup run

tags: StringList

A list of tags for this snapshot

original: Option<SnapshotId>

The original Id of this snapshot. This is stored when the snapshot is modified.

delete: DeleteOption

Options for deletion of the snapshot

summary: Option<SnapshotSummary>

Summary information about the backup run

description: Option<String>

A description of what is contained in this snapshot

id: SnapshotId

The snapshot Id (not stored within the JSON)

Implementations

impl SnapshotFile

pub fn from_options(opts: &SnapshotOptions) -> RusticResult<Self>

Create a SnapshotFile from SnapshotOptions.

Arguments

• opts - The SnapshotOptions to use

Errors

• If the hostname is not valid unicode
• If the delete time is not in the range of Local::now()
• If the description file could not be read

Note

This is the preferred way to create a new SnapshotFile to be used within crate::Repository::backup.

fn set_id(tuple: (SnapshotId, Self)) -> Self

Create a SnapshotFile from a given Id and RepoFile.

Arguments

• tuple - A tuple of the Id and the RepoFile to use

fn from_backend<B: DecryptReadBackend>( be: &B, id: &SnapshotId, ) -> RusticResult<Self>

Get a SnapshotFile from the backend

Arguments

• be - The backend to use
• id - The id of the snapshot

pub(crate) fn from_str<B: DecryptReadBackend>( be: &B, string: &str, predicate: impl FnMut(&Self) -> bool + Send + Sync, p: &Progress, ) -> RusticResult<Self>

Get a SnapshotFile from the backend by (part of the) Id

Works with a snapshot Id or a latest indexed syntax: latest or latest~N with N >= 0

Arguments

• be - The backend to use
• string - The (part of the) id of the snapshot
• predicate - A predicate to filter the snapshots
• p - A progress bar to use

Errors

• If the string is not a valid hexadecimal string
• If no id could be found.
• If the id is not unique.
• If the latest syntax is “detected” but inexact

pub(crate) fn from_strs<B: DecryptReadBackend, S: AsRef<str>>( be: &B, strings: &[S], predicate: impl FnMut(&Self) -> bool + Send + Sync, p: &Progress, ) -> RusticResult<Vec<Self>>

Get a Vec<SnapshotFile> from the backend by (part of the) Ids

Works with a snapshot Id or a latest indexed syntax: latest or latest~N with N >= 0

Arguments

• be - The backend to use
• string - The (part of the) id of the snapshot
• predicate - A predicate to filter the snapshots
• p - A progress bar to use

Errors

• If the string is not a valid hexadecimal string
• If no id could be found.
• If the id is not unique.
• If the latest syntax is “detected” but inexact

pub(crate) fn latest<B: DecryptReadBackend>( be: &B, predicate: impl FnMut(&Self) -> bool + Send + Sync, p: &Progress, ) -> RusticResult<Self>

Get the latest SnapshotFile from the backend

Arguments

• be - The backend to use
• predicate - A predicate to filter the snapshots
• p - A progress bar to use

Errors

• If no snapshots are found

fn latest_n_from_iter( n: usize, iter: impl IntoIterator<Item = Self>, ) -> RusticResult<Vec<Self>>

pub(crate) fn latest_n<B: DecryptReadBackend>( be: &B, predicate: impl FnMut(&Self) -> bool + Send + Sync, p: &Progress, n: usize, ) -> RusticResult<Self>

Get the latest SnapshotFile from the backend

Arguments

• be - The backend to use
• predicate - A predicate to filter the snapshots
• p - A progress bar to use
• n - The n-latest index to go back for snapshot

Errors

• If no snapshots are found

pub(crate) fn from_id<B: DecryptReadBackend>( be: &B, id: &str, ) -> RusticResult<Self>

Get a SnapshotFile from the backend by (part of the) id

Arguments

• be - The backend to use
• id - The (part of the) id of the snapshot

Errors

• If the string is not a valid hexadecimal string
• If no id could be found.
• If the id is not unique.

pub(crate) fn from_ids<B: DecryptReadBackend, T: AsRef<str>>( be: &B, ids: &[T], p: &Progress, ) -> RusticResult<Vec<Self>>

Get a list of SnapshotFiles from the backend by supplying a list of/parts of their Ids

Arguments

• be - The backend to use
• ids - The list of (parts of the) ids of the snapshots
• p - A progress bar to use

Errors

• If the string is not a valid hexadecimal string
• If no id could be found.
• If the id is not unique.

pub(crate) fn update_from_ids<B: DecryptReadBackend, T: AsRef<str>>( be: &B, current: Vec<Self>, ids: &[T], p: &Progress, ) -> RusticResult<Vec<Self>>

Update a list of SnapshotFiles from the backend by supplying a list of/parts of their Ids

Arguments

• be - The backend to use
• ids - The list of (parts of the) ids of the snapshots
• p - A progress bar to use

Errors

• If the string is not a valid hexadecimal string
• If no id could be found.
• If the id is not unique.

fn fill_missing<B, F>( be: &B, current: Vec<Self>, ids: &[Id], filter: F, p: &Progress, ) -> RusticResult<Vec<Self>>

where B: DecryptReadBackend, F: FnMut(&Self) -> bool,

pub(crate) fn iter_all_from_backend<B, F>( be: &B, filter: F, p: &Progress, ) -> RusticResult<impl Iterator<Item = Self>>

where B: DecryptReadBackend, F: FnMut(&Self) -> bool,

pub(crate) fn update_from_backend<B, F>( be: &B, current: Vec<Self>, filter: F, p: &Progress, ) -> RusticResult<Vec<Self>>

where B: DecryptReadBackend, F: FnMut(&Self) -> bool,

pub fn add_tags(&mut self, tag_lists: Vec<StringList>) -> bool

Add tag lists to snapshot.

Arguments

• tag_lists - The tag lists to add

Returns

Returns whether snapshot was changed.

pub fn set_tags(&mut self, tag_lists: Vec<StringList>) -> bool

Set tag lists to snapshot.

Arguments

• tag_lists - The tag lists to set

Returns

Returns whether snapshot was changed.

pub fn remove_tags(&mut self, tag_lists: &[StringList]) -> bool

Remove tag lists from snapshot.

Arguments

• tag_lists - The tag lists to remove

Returns

Returns whether snapshot was changed.

pub fn must_delete(&self, now: &Zoned) -> bool

Returns whether a snapshot must be deleted now

Arguments

• now - The current time

pub fn must_keep(&self, now: &Zoned) -> bool

Returns whether a snapshot must be kept now

Arguments

• now - The current time

pub fn modify( &mut self, modification: &SnapshotModification, ) -> RusticResult<bool>

Modifies the snapshot according to a SnapshotModification.

Arguments

• modification - The modification(s) to make

Returns

true if the snapshot was changed.

Errors

if reading a description from a file failed

pub(crate) fn clear_ids(sn: Self) -> Self

Clear ids which are not saved by the copy command (and not compared when checking if snapshots already exist in the copy target)

Arguments

• sn - The snapshot to clear the ids from

pub fn get_parents(&self) -> &[SnapshotId]

Convenience method to get parent snapshots which are stored in the parent or parents field.

Trait Implementations

impl Clone for SnapshotFile

fn clone(&self) -> SnapshotFile

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SnapshotFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SnapshotFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SnapshotFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Grouping for SnapshotFile

type GroupKey = SnapshotGroup

type Criterion = SnapshotGroupCriterion

fn get_group(&self, c: Self::Criterion) -> Self::GroupKey

impl Ord for SnapshotFile

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SnapshotFile

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for SnapshotFile

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RepoFile for SnapshotFile

const TYPE: FileType = FileType::Snapshot

The FileType associated with the repository file

type Id = SnapshotId

The Id type associated with the repository file

const ENCRYPTED: bool = true

Indicate whether the files are stored encrypted

impl Serialize for SnapshotFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SnapshotFile