hoard 0.6.1

Hoard backups of files across your filesystem into one location.
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

//! Provides filters for determining whether a path should be backed up or not.

use crate::hoard::PileConfig;
use crate::paths::{RelativePath, SystemPath};

pub(crate) mod ignore;

/// The [`Filter`] trait provides a common interface for all filters.
pub trait Filter: Sized {
    /// Creates a new instance of something that implements [`Filter`].
    ///
    /// # Errors
    ///
    /// Any errors that may occur while creating the new filter.
    fn new(pile_config: &PileConfig) -> Self;
    /// Whether or not the file should be kept (backed up).
    fn keep(&self, prefix: &SystemPath, path: &RelativePath) -> bool;
}

/// A wrapper for all implmented filters.
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
pub struct Filters {
    ignore: ignore::IgnoreFilter,
}

impl Filter for Filters {
    #[tracing::instrument]
    fn new(pile_config: &PileConfig) -> Self {
        let ignore = ignore::IgnoreFilter::new(pile_config);
        Self { ignore }
    }

    #[tracing::instrument(name = "run_filters")]
    fn keep(&self, prefix: &SystemPath, path: &RelativePath) -> bool {
        self.ignore.keep(prefix, path)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_filters_derives() {
        let config = PileConfig {
            ignore: vec![glob::Pattern::new("valid/**").unwrap()],
            ..PileConfig::default()
        };
        let filters = Filters::new(&config);
        assert!(format!("{filters:?}").contains("Filters"));
        assert_eq!(filters.clone().ignore, filters.ignore);
    }
}