Struct PrunePlan 

pub struct PrunePlan {
    time: DateTime<Local>,
    used_ids: BTreeMap<BlobId, u8>,
    existing_packs: BTreeMap<PackId, u32>,
    repack_candidates: Vec<(PackInfo, EnumSet<PackStatus>, RepackReason, usize, usize)>,
    index_files: Vec<PruneIndex>,
    pub stats: PruneStats,
}

A plan what should be repacked or removed by a prune run

Fields

time: DateTime<Local>

The time the plan was created

used_ids: BTreeMap<BlobId, u8>

The ids of the blobs which are used

existing_packs: BTreeMap<PackId, u32>

The ids of the existing packs

repack_candidates: Vec<(PackInfo, EnumSet<PackStatus>, RepackReason, usize, usize)>

The packs which should be repacked

index_files: Vec<PruneIndex>

The index files

stats: PruneStats

prune statistics

Implementations

impl PrunePlan

fn new( used_ids: BTreeMap<BlobId, u8>, existing_packs: BTreeMap<PackId, u32>, index_files: Vec<(IndexId, IndexFile)>, ) -> Self

Create a new PrunePlan

Arguments

• used_ids - The ids of the blobs which are used
• existing_packs - The ids of the existing packs
• index_files - The index files

pub fn from_prune_options<P: ProgressBars, S: Open>( repo: &Repository<P, S>, opts: &PruneOptions, ) -> RusticResult<Self>

Get a PrunePlan from the given PruneOptions.

Type Parameters

• P - The progress bar type
• S - The state the repository is in

Arguments

• repo - The repository to get the PrunePlan for
• opts - The PruneOptions to use

Errors

• If repack_uncompressed is set and the repository is a version 1 repository
• If keep_pack or keep_delete is out of range

fn count_used_blobs(&mut self)

This function counts the number of times a blob is used in the index files.

fn check(&self) -> RusticResult<()>

This function checks whether all used blobs are present in the index files.

Errors

• If a blob is missing

fn decide_packs( &mut self, keep_pack: Duration, keep_delete: Duration, repack_cacheable_only: bool, repack_uncompressed: bool, repack_all: bool, pack_sizer: &EnumMap<BlobType, PackSizer>, ) -> RusticResult<()>

Decides what to do with the packs

Arguments

• keep_pack - The minimum duration to keep packs before repacking or removing
• keep_delete - The minimum duration to keep packs marked for deletion
• repack_cacheable_only - Whether to only repack cacheable packs
• repack_uncompressed - Whether to repack packs containing uncompressed blobs
• repack_all - Whether to repack all packs
• pack_sizer - The PackSizer for the packs

Errors

fn decide_repack( &mut self, max_repack: &LimitOption, max_unused: &LimitOption, repack_uncompressed: bool, no_resize: bool, pack_sizer: &EnumMap<BlobType, PackSizer>, )

Decides if packs should be repacked

Arguments

• max_repack - The maximum size of packs to repack
• max_unused - The maximum size of unused blobs
• repack_uncompressed - Whether to repack packs containing uncompressed blobs
• no_resize - Whether to resize packs
• pack_sizer - The PackSizer for the packs

Errors

fn check_existing_packs(&mut self) -> RusticResult<()>

Checks if the existing packs are ok

Errors

• If a pack is undecided
• If the size of a pack does not match
• If a pack does not exist

fn filter_index_files(&mut self, instant_delete: bool)

Filter out index files which do not need processing

Arguments

• instant_delete - Whether to instantly delete unreferenced packs

pub fn repack_packs(&self) -> Vec<PackId>

Get the list of packs-to-repack from the PrunePlan.

pub fn do_prune<P: ProgressBars, S: Open>( self, repo: &Repository<P, S>, opts: &PruneOptions, ) -> RusticResult<()>

👎Deprecated since 0.5.2: Use Repository::prune() instead.

Perform the pruning on the given repository.

Arguments

• repo - The repository to prune
• opts - The options for the pruning

Errors

• If the repository is in append-only mode
• If a pack has no decision

Returns

• Ok(()) - If the pruning was successful

Panics

TODO! In weird circumstances, should be fixed.

Trait Implementations

impl Debug for PrunePlan

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

Formats the value using the given formatter.