document Repository

rustic-rs · Jul 30, 2023 · 91b8c8d · 91b8c8d
1 parent 8337a1b
commit 91b8c8d
Show file tree

Hide file tree

Showing 12 changed files with 148 additions and 19 deletions.
diff --git a/crates/rustic_core/src/commands/backup.rs b/crates/rustic_core/src/commands/backup.rs
@@ -12,8 +12,8 @@ use crate::{
     backend::{dry_run::DryRunBackend, stdin::StdinSource},
     repofile::SnapshotFile,
     repository::{IndexedIds, IndexedTree},
-    Id, LocalSource, LocalSourceFilterOptions, LocalSourceSaveOptions, Open, PathList,
-    ProgressBars, Repository, RusticResult, SnapshotGroup, SnapshotGroupCriterion,
+    Id, LocalSource, LocalSourceFilterOptions, LocalSourceSaveOptions, PathList, ProgressBars,
+    Repository, RusticResult, SnapshotGroup, SnapshotGroupCriterion,
 };
 
 #[cfg_attr(feature = "clap", derive(clap::Parser))]

diff --git a/crates/rustic_core/src/commands/config.rs b/crates/rustic_core/src/commands/config.rs
@@ -6,7 +6,8 @@ use crate::{
     backend::decrypt::{DecryptBackend, DecryptWriteBackend},
     error::CommandErrorKind,
     repofile::ConfigFile,
-    Key, Open, Repository, RusticResult,
+    repository::Open,
+    Key, Repository, RusticResult,
 };
 
 pub(crate) fn apply_config<P, S: Open>(

diff --git a/crates/rustic_core/src/commands/copy.rs b/crates/rustic_core/src/commands/copy.rs
@@ -8,8 +8,8 @@ use crate::{
     blob::{packer::Packer, tree::TreeStreamerOnce, BlobType},
     index::{indexer::Indexer, IndexedBackend, ReadIndex},
     repofile::SnapshotFile,
-    repository::{IndexedFull, IndexedIds, IndexedTree},
-    Open, ProgressBars, Repository, RusticResult,
+    repository::{IndexedFull, IndexedIds, IndexedTree, Open},
+    ProgressBars, Repository, RusticResult,
 };
 
 #[derive(Debug)]

diff --git a/crates/rustic_core/src/commands/key.rs b/crates/rustic_core/src/commands/key.rs
@@ -6,7 +6,8 @@ use crate::{
     crypto::hasher::hash,
     error::CommandErrorKind,
     repofile::KeyFile,
-    Id, Key, Open, Repository, RusticResult,
+    repository::Open,
+    Id, Key, Repository, RusticResult,
 };
 
 #[cfg_attr(feature = "clap", derive(clap::Parser))]

diff --git a/crates/rustic_core/src/commands/merge.rs b/crates/rustic_core/src/commands/merge.rs
@@ -15,7 +15,7 @@ use crate::{
     index::{indexer::Indexer, ReadIndex},
     repofile::{SnapshotFile, SnapshotSummary},
     repository::IndexedTree,
-    Id, Open, PathList, Progress, ProgressBars, Repository, RusticResult,
+    Id, PathList, Progress, ProgressBars, Repository, RusticResult,
 };
 
 pub(crate) fn merge_snapshots<P: ProgressBars, S: IndexedTree>(

diff --git a/crates/rustic_core/src/commands/repair/index.rs b/crates/rustic_core/src/commands/repair/index.rs
@@ -12,7 +12,8 @@ use crate::{
     error::CommandErrorKind,
     index::indexer::Indexer,
     repofile::{IndexFile, IndexPack, PackHeader, PackHeaderRef},
-    Open, Progress, ProgressBars, Repository, RusticResult,
+    repository::Open,
+    Progress, ProgressBars, Repository, RusticResult,
 };
 
 #[cfg_attr(feature = "clap", derive(clap::Parser))]

diff --git a/crates/rustic_core/src/commands/repair/snapshots.rs b/crates/rustic_core/src/commands/repair/snapshots.rs
@@ -10,7 +10,7 @@ use crate::{
     index::{indexer::Indexer, IndexedBackend, ReadIndex},
     repofile::SnapshotFile,
     repository::{IndexedFull, IndexedTree},
-    Id, Open, ProgressBars, Repository, RusticResult, StringList,
+    Id, ProgressBars, Repository, RusticResult, StringList,
 };
 
 #[cfg_attr(feature = "clap", derive(clap::Parser))]

diff --git a/crates/rustic_core/src/commands/restore.rs b/crates/rustic_core/src/commands/restore.rs
@@ -24,8 +24,8 @@ use crate::{
     },
     blob::BlobType,
     error::CommandErrorKind,
-    repository::{IndexedFull, IndexedTree},
-    Id, LocalDestination, Open, Progress, ProgressBars, Repository, RusticResult,
+    repository::{IndexedFull, IndexedTree, Open},
+    Id, LocalDestination, Progress, ProgressBars, Repository, RusticResult,
 };
 
 pub(crate) mod constants {

diff --git a/crates/rustic_core/src/lib.rs b/crates/rustic_core/src/lib.rs
@@ -128,5 +128,5 @@ pub use crate::{
     repofile::snapshotfile::{
         PathList, SnapshotGroup, SnapshotGroupCriterion, SnapshotOptions, StringList,
     },
-    repository::{IndexedFull, Open, OpenStatus, Repository, RepositoryOptions},
+    repository::{IndexedFull, OpenStatus, Repository, RepositoryOptions},
 };
diff --git a/crates/rustic_core/src/repofile/snapshotfile.rs b/crates/rustic_core/src/repofile/snapshotfile.rs
@@ -756,6 +756,7 @@ impl StringList {
         self.0.join("\n")
     }
 
+    /// Turn StringList into an Iterator
     pub fn iter(&self) -> std::slice::Iter<'_, String> {
         self.0.iter()
     }