Struct conserve::archive::Archive

pub struct Archive { /* private fields */ }

An archive holding backup material.

Implementations

impl Archive

pub fn create_path(path: &Path) -> Result<Archive>

Make a new archive in a local directory.

pub fn create(transport: Arc<dyn Transport>) -> Result<Archive>

Make a new archive in a new directory accessed by a Transport.

pub fn open_path(path: &Path) -> Result<Archive>

Open an existing archive.

Checks that the header is correct.

pub fn open(transport: Arc<dyn Transport>) -> Result<Archive>

pub fn block_dir(&self) -> &BlockDir

pub fn band_exists(&self, band_id: BandId) -> Result<bool>

pub fn band_is_closed(&self, band_id: BandId) -> Result<bool>

pub fn iter_entries( &self, band_selection: BandSelectionPolicy, subtree: Apath, exclude: Exclude ) -> Result<impl Iterator<Item = IndexEntry>>

Return an iterator of entries in a selected version.

pub fn list_band_ids(&self) -> Result<Vec<BandId>>

Returns a vector of band ids, in sorted order from first to last.

pub fn resolve_band_id( &self, band_selection: BandSelectionPolicy ) -> Result<BandId>

pub fn open_stored_tree( &self, band_selection: BandSelectionPolicy ) -> Result<StoredTree>

pub fn last_band_id(&self) -> Result<Option<BandId>>

Return the BandId of the highest-numbered band, or Ok(None) if there are no bands, or an Err if any occurred reading the directory.

pub fn last_complete_band(&self) -> Result<Option<Band>>

Return the last completely-written band id, if any.

pub fn referenced_blocks( &self, band_ids: &[BandId], monitor: Arc<dyn Monitor> ) -> Result<HashSet<BlockHash>>

Returns all blocks referenced by all bands.

Shows a progress bar as they’re collected.

pub fn unreferenced_blocks( &self, monitor: Arc<dyn Monitor> ) -> Result<impl ParallelIterator<Item = BlockHash>>

Returns an iterator of blocks that are present and referenced by no index.

pub fn delete_bands( &self, delete_band_ids: &[BandId], options: &DeleteOptions, monitor: Arc<dyn Monitor> ) -> Result<DeleteStats>

Delete bands, and the blocks that they reference.

If delete_band_ids is empty, this deletes no bands, but will delete any garbage blocks referenced by no existing bands.

pub fn validate( &self, options: &ValidateOptions, monitor: Arc<dyn Monitor> ) -> Result<()>

Walk the archive to check all invariants.

If problems are found, they are emitted as warn or error level tracing messages. This function only returns an error if validation stops due to a fatal error.

Trait Implementations

impl AsRef<Archive> for ScratchArchive

fn as_ref(&self) -> &Archive

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Archive

fn clone(&self) -> Archive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Archive

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

Formats the value using the given formatter.