mithril_aggregator/services/snapshotter/
interface.rs

1use async_trait::async_trait;
2
3use mithril_common::entities::{CompressionAlgorithm, ImmutableFileNumber};
4use mithril_common::StdResult;
5
6use crate::tools::file_archiver::FileArchive;
7
8#[cfg_attr(test, mockall::automock)]
9#[async_trait]
10/// Define the ability to create snapshots.
11pub trait Snapshotter: Sync + Send {
12    /// Create a new snapshot containing all completed immutables.
13    async fn snapshot_all_completed_immutables(
14        &self,
15        archive_name_without_extension: &str,
16    ) -> StdResult<FileArchive>;
17
18    /// Create a new snapshot of ancillary files.
19    ///
20    /// Ancillary files include the last, uncompleted, immutable trio and the last ledger file.
21    async fn snapshot_ancillary(
22        &self,
23        immutable_file_number: ImmutableFileNumber,
24        archive_name_without_extension: &str,
25    ) -> StdResult<FileArchive>;
26
27    /// Create a new snapshot of an immutable trio.
28    async fn snapshot_immutable_trio(
29        &self,
30        immutable_file_number: ImmutableFileNumber,
31        archive_name_without_extension: &str,
32    ) -> StdResult<FileArchive>;
33
34    /// Return the compression algorithm used by the snapshotter.
35    fn compression_algorithm(&self) -> CompressionAlgorithm;
36}