froe 0.12.0

Reader and offline maintenance toolkit for Apache Jackrabbit Oak segment-tar (TarMK) repositories: parse archives and records, extract node data, compact, back up, and recover.
Documentation 
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

//! Conservative offline maintenance for an existing segment-tar repository.
//!
//! Cleanup is deliberately split into a read-only plan and a prepared apply
//! session. Planning never acquires `repo.lock` and never opens the ordinary
//! writable repository (whose startup lifecycle repairs archives and rewrites
//! the manifest). A prepared session takes the repository lock, rebuilds the
//! plan from disk, fingerprints every directory entry, and holds the lock
//! until application and fresh post-operation verification complete.
//!
//! Every test lives with the stage it exercises, including the end-to-end
//! ones: a claim about what the apply phase refuses belongs beside the
//! apply phase even when it is made through `plan_compaction`.

#[cfg(test)]
mod test_support;

mod apply;
mod apply_identity;
mod checkpoints;
mod file_removal;
pub(crate) mod gate_observation;
mod indexless_refusal;
/// Everything maintenance does with the journal: classifying its lines,
/// and rewriting the file that holds them.
mod journal;
mod manifest;
mod options;
mod plan;
mod planning;
mod prepared;
mod reclamation;
mod recovery_backups;
mod stale_archives;
mod surveys;
mod temporaries;

#[cfg(test)]
#[cfg(unix)]
pub(crate) use self::options::MaintenanceTask;
// The open protocol's gates, for the index module's own prepare. See
// `planning/mod.rs` for why they are widened rather than moved.
pub(crate) use self::apply_identity::{
    validate_apply_environment, validate_apply_identity, validate_metadata_source_apply_identity,
};
pub use self::options::{CompactionOptions, RecoveryBackupPolicy};
pub use self::plan::{
    CompactedGeneration, CompactionAction, CompactionOutcome, CompactionPlan,
    ExternalBinaryFootprint, FileDeletionFailure, JournalLineRemoval, JournalRemovalReason,
    OrphanedVersionHistoryReport, StaleArchiveReason,
};
pub(crate) use self::planning::{
    DirectoryFingerprint, available_filesystem_bytes, canonical_repository_directory,
    directory_fingerprint, validate_repository_shape,
};
pub use self::prepared::{
    PreparedCompaction, compact, compact_with_progress, plan_compaction,
    plan_compaction_with_progress,
};
pub use self::surveys::{
    ArchiveIndexSurvey, RecoveryBackupSurvey, survey_archive_indexes, survey_recovery_backups,
};