microsandbox 0.7.2

`microsandbox` is the core library for the microsandbox project.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

//! Snapshot archive copies with replacement metadata.

use std::collections::BTreeMap;
use std::path::PathBuf;

use super::{Manifest, Snapshot};
use crate::MicrosandboxResult;

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// Builder for packaging a snapshot as a new archive with replacement metadata.
///
/// Created by [`Snapshot::copy_to`]. The source snapshot is never modified.
pub struct SnapshotCopyBuilder {
    snapshot: Snapshot,
    output_archive_path: PathBuf,
    labels: BTreeMap<String, String>,
    record_integrity: bool,
}

//--------------------------------------------------------------------------------------------------
// Methods
//--------------------------------------------------------------------------------------------------

impl SnapshotCopyBuilder {
    pub(super) fn new(snapshot: Snapshot, output_archive_path: PathBuf) -> Self {
        Self {
            snapshot,
            output_archive_path,
            labels: BTreeMap::new(),
            record_integrity: false,
        }
    }

    /// Replace the archive's labels, stored outside the immutable descriptor.
    /// Defaults to an empty label map.
    pub fn labels(mut self, labels: BTreeMap<String, String>) -> Self {
        self.labels = labels;
        self
    }

    /// Choose whether to calculate and record disk integrity in the copy.
    /// Disabled by default; existing descriptor integrity is omitted in that case.
    pub fn record_integrity(mut self, enabled: bool) -> Self {
        self.record_integrity = enabled;
        self
    }

    /// Package the configured disk copy and return its manifest.
    ///
    /// Identical descriptor bytes retain their portable identity. A changed integrity
    /// policy creates a new snapshot identity while retaining source provenance.
    /// Full-state snapshots use `Snapshot::save_to` instead.
    pub async fn save(self) -> MicrosandboxResult<Manifest> {
        self.snapshot
            .backend
            .snapshots()
            .copy(
                &self.snapshot,
                &self.output_archive_path,
                self.labels,
                self.record_integrity,
            )
            .await
    }
}