Struct BackupManager 

pub struct BackupManager<V: VaultOperations> {
    pub config: BackupConfig,
    /* private fields */
}

Fields

config: BackupConfig

Implementations

impl<V: VaultOperations> BackupManager<V>

pub const fn new(vault: V, config: BackupConfig) -> Self

pub fn backup_if_needed(&mut self) -> Result<Option<PathBuf>>

Attempts to create a backup if specific conditions are met.

This function checks if the backup functionality is enabled in the configuration and if the current state meets the criteria for performing a backup. If both conditions are satisfied, the backup process is initiated.

Returns

• Ok(Some(PathBuf)) - Path to the backup if a backup was successfully created.
• Ok(None) - If backup functionality is disabled or the conditions for backup are not met.
• Err - If an error occurs during the preconditions check or while performing the backup.

Errors

This function may return an error in the following cases:

• An error occurs while determining if a backup should be performed (should_backup).
• An error occurs during the execution of the backup process (perform_backup).

pub fn force_backup(&mut self) -> Result<PathBuf>

Forces the initiation of a backup and ensures its successful completion.

This function triggers the backup process in a guaranteed manner and ensures that the resulting backup is successfully created. It internally calls the perform_backup function and expects it to return a successful result. If perform_backup fails or does not produce a valid backup, this function will panic with a message indicating the failure.

Returns

Returns a Result<PathBuf> containing the path to the completed backup if successful, or an error if the backup process fails.

Errors

This function propagates any errors encountered during the call to perform_backup. Additionally, it will panic if perform_backup does not yield a valid backup path.

Panics

Panics with the message "Backup failed to perform" if the result of perform_backup is None despite the operation succeeding.

pub fn find_all_backups(&self) -> Result<Vec<PathBuf>>

Finds and returns all backup files located in the configured backup directory.

This method scans the backup directory specified in the configuration and identifies all files that meet the criteria for being considered backup files (as determined by the is_backup_file method).

Returns

• Ok(Vec<PathBuf>) - A vector containing the paths to all identified backup files.
• Err(io::Error) - If an error occurs while reading the backup directory or its entries.

Behavior

• If the configured backup directory does not exist, the method returns an empty vector wrapped in Ok.
• If the directory exists, the method iterates through its contents and adds any files matching the backup file criteria to the result vector.

Errors

This function returns an Err if:

• The backup_dir cannot be read (e.g., due to insufficient permissions).
• An error occurs while iterating over entries within the directory.

pub fn find_most_recent_backup(&self) -> Result<Option<PathBuf>>

Finds the most recent backup file from a list of backup files.

This method retrieves all backup files by invoking the find_all_backups method. It iterates through each backup file to extract its timestamp using the extract_timestamp_from_filename method. The backup file with the most recent timestamp is identified and returned.

Returns

• Ok(Some(PathBuf)) - A PathBuf representing the most recent backup file, if any backups exist.
• Ok(None) - Indicates no backup files were found.
• Err - Propagates any errors that occur while retrieving the list of backups or extracting timestamps.

Errors

This method returns an error if:

• The find_all_backups method fails to retrieve the list of backup files.
• Any other internal method call fails.

Implementation Details

• The backups are identified and sorted based on their timestamp. The timestamp is derived from the filename by using the extract_timestamp_from_filename method.
• The initial reference timestamp is set to the UNIX epoch (OffsetDateTime::UNIX_EPOCH).

pub fn extract_timestamp_from_filename( &self, path: &Path, ) -> Option<OffsetDateTime>