adapt init and docu

Author: aawsome

crates/core/src/commands/init.rs

@@ -47,11 +47,6 @@ pub(crate) fn init<P, S>(
     let repo_id = RepositoryId::from(Id::random());
     let chunker_poly = random_poly()?;
     let mut config = ConfigFile::new(2, repo_id, chunker_poly);
-    if repo.be_hot.is_some() {
-        // for hot/cold repository, `config` must be identical to thee config file which is read by the backend, i.e. the one saved in the hot repo.
-        // Note: init_with_config does handle the is_hot config correctly for the hot and the cold repo.
-        config.is_hot = Some(true);
-    }
     config_opts.apply(&mut config)?;
 
     let key = init_with_config(repo, pass, key_opts, &config)?;
@@ -60,7 +55,7 @@ pub(crate) fn init<P, S>(
     Ok((key, config))
 }
 
-/// Save a [`ConfigFile`] only to the hot part of a repository
+/// Initialize a new repository using a given [`ConfigFile`]
 ///
 /// # Type Parameters
 ///
@@ -69,15 +64,18 @@ pub(crate) fn init<P, S>(
 ///
 /// # Arguments
 ///
-/// * `repo` - The repository to save the config to
-/// * `new_config` - The config to save
-/// * `key` - The key to encrypt the config with
+/// * `repo` - The repository to initialize.
+/// * `pass` - The password to encrypt the key with.
+/// * `key_opts` - The options to create the key with.
+/// * `config` - The config to use
 ///
 /// # Errors
 ///
-/// * [`CryptBackendErrorKind::SerializingToJsonByteVectorFailed`] - If the file could not be serialized to json.
+/// * If the file could not be serialized to json.
+///
+/// # Returns
 ///
-/// [`CryptBackendErrorKind::SerializingToJsonByteVectorFailed`]: crate::error::CryptBackendErrorKind::SerializingToJsonByteVectorFailed
+/// The key used to encrypt the config.
 pub(crate) fn init_with_config<P, S>(
     repo: &Repository<P, S>,
     pass: &str,

crates/core/src/commands/repair/hotcold.rs

@@ -10,6 +10,17 @@ use crate::{
     RusticResult, WriteBackend, ALL_FILE_TYPES,
 };
 
+/// Repairs a hot/cold repository by copying missing files (except pack files) over from one to the other part.
+///
+/// # Type Parameters
+///
+/// * `P` - The progress bar type.
+/// * `S` - The state the repository is in.
+///
+/// # Arguments
+///
+/// * `repo` - The repository
+/// * `dry_run` - Do a dry run
 pub(crate) fn repair_hotcold<P: ProgressBars, S>(
     repo: &Repository<P, S>,
     dry_run: bool,
@@ -22,6 +33,17 @@ pub(crate) fn repair_hotcold<P: ProgressBars, S>(
     Ok(())
 }
 
+/// Repairs a hot/cold repository by copying missing tree pack files over from one to the other part.
+///
+/// # Type Parameters
+///
+/// * `P` - The progress bar type.
+/// * `S` - The state the repository is in.
+///
+/// # Arguments
+///
+/// * `repo` - The repository
+/// * `dry_run` - Do a dry run
 pub(crate) fn repair_hotcold_packs<P: ProgressBars, S: Open>(
     repo: &Repository<P, S>,
     dry_run: bool,
@@ -35,6 +57,19 @@ pub(crate) fn repair_hotcold_packs<P: ProgressBars, S: Open>(
     )
 }
 
+/// Copy relevant+misssing files in a hot/cold repository from one to the other part.
+///
+/// # Type Parameters
+///
+/// * `P` - The progress bar type.
+/// * `S` - The state the repository is in.
+///
+/// # Arguments
+///
+/// * `repo` - The repository
+/// * `file_type` - The filetype to copy
+/// * `is_relevalt` - A closure to determine whether the id is relevat
+/// * `dry_run` - Do a dry run
 pub(crate) fn correct_missing_files<P: ProgressBars, S>(
     repo: &Repository<P, S>,
     file_type: FileType,
@@ -91,6 +126,14 @@ pub(crate) fn correct_missing_files<P: ProgressBars, S>(
     Ok(())
 }
 
+/// Copy a list of files from one repo to another.
+///
+/// # Arguments
+///
+/// * `files` - The list of file ids to copy
+/// * `file_type` - The filetype to copy
+/// * `from` - The backend to read from
+/// * `to` - The backend to write to
 fn copy(
     files: Vec<Id>,
     file_type: FileType,
@@ -104,6 +147,20 @@ fn copy(
     Ok(())
 }
 
+/// Get all tree packs from from within the repository.
+///
+/// # Type Parameters
+///
+/// * `P` - The progress bar type.
+/// * `S` - The state the repository is in.
+///
+/// # Arguments
+///
+/// * `repo` - The repository
+///
+/// # Returns
+///
+/// The set of pack ids.
 pub(crate) fn get_tree_packs<P: ProgressBars, S: Open>(
     repo: &Repository<P, S>,
 ) -> RusticResult<BTreeSet<PackId>> {
@@ -121,6 +178,22 @@ pub(crate) fn get_tree_packs<P: ProgressBars, S: Open>(
     Ok(tree_packs)
 }
 
+/// Find missing files in the hot or cold part of the repository.
+///
+/// # Type Parameters
+///
+/// * `P` - The progress bar type.
+/// * `S` - The state the repository is in.
+///
+/// # Arguments
+///
+/// * `repo` - The repository
+/// * `file_type` - The filetype to use
+/// * `is_relevalt` - A closure to determine whether the id is relevat
+///
+/// # Returns
+///
+/// A tuple containing ids missing in hot part, the total size, ids missing in cold part and the corresponding total size.
 pub(crate) fn get_missing_files<P: ProgressBars, S>(
     repo: &Repository<P, S>,
     file_type: FileType,

crates/core/src/repository.rs

@@ -708,18 +708,18 @@ impl<P, S> Repository<P, S> {
     /// * If the config file has `is_hot` set to `false` but the repository is hot
     fn open_raw(mut self, key: Key, config: ConfigFile) -> RusticResult<Repository<P, OpenStatus>> {
         match (config.is_hot == Some(true), self.be_hot.is_some()) {
-            (true, false) => return Err(
-                RusticError::new(
+            (true, false) => {
+                return Err(RusticError::new(
                     ErrorKind::Repository,
                     "The given repository is a hot repository! Please use `--repo-hot` in combination with the normal repo. Aborting.",
-                )
-            ),
-            (false, true) => return Err(
-                RusticError::new(
+                ));
+            }
+            (false, true) => {
+                return Err(RusticError::new(
                     ErrorKind::Repository,
                     "The given repository is not a hot repository! Aborting.",
-                )
-            ),
+                ));
+            }
             _ => {}
         }
 
@@ -944,24 +944,10 @@ impl<P, S: Open> Repository<P, S> {
         self.status.dbe()
     }
 
-    /// Save a [`ConfigFile`] only to the hot part of a repository
-    ///
-    /// # Type Parameters
-    ///
-    /// * `P` - The progress bar type.
-    /// * `S` - The state the repository is in.
-    ///
-    /// # Arguments
-    ///
-    /// * `repo` - The repository to save the config to
-    /// * `new_config` - The config to save
-    /// * `key` - The key to encrypt the config with
-    ///
+    /// Init only the hot repository, i.e. Save the  [`ConfigFile`] only to the hot part of a repository
     /// # Errors
     ///
-    /// * [`CryptBackendErrorKind::SerializingToJsonByteVectorFailed`] - If the file could not be serialized to json.
-    ///
-    /// [`CryptBackendErrorKind::SerializingToJsonByteVectorFailed`]: crate::error::CryptBackendErrorKind::SerializingToJsonByteVectorFailed
+    /// * If the config file could not be saved.
     pub fn init_hot(&self) -> RusticResult<()> {
         if let Some(hot_be) = self.be_hot.clone() {
             hot_be.create()?;
@@ -1203,12 +1189,10 @@ impl<P: ProgressBars, S: Open> Repository<P, S> {
     /// * If the files could not be deleted.
     pub fn delete_snapshots(&self, ids: &[SnapshotId]) -> RusticResult<()> {
         if self.config().append_only == Some(true) {
-            return Err(
-                RusticError::new(
-                    ErrorKind::Repository,
-                    "Repository is in append-only mode and snapshots cannot be deleted from it. Aborting.",
-                )
-            );
+            return Err(RusticError::new(
+                ErrorKind::Repository,
+                "Repository is in append-only mode and snapshots cannot be deleted from it. Aborting.",
+            ));
         }
         let p = self.pb.progress_counter("removing snapshots...");
         self.dbe().delete_list(true, ids.iter(), p)?;