etcetera 0.11.0

An unopinionated library for obtaining configuration, data, cache, & other directories
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use std::path::{Path, PathBuf};

use crate::HomeDirError;

/// This strategy has no standard or official specification. It has arisen over time through hundreds of Unixy tools. Vim and Cargo are notable examples whose configuration/data/cache directory layouts are similar to those created by this strategy.
///
/// ```
/// use etcetera::app_strategy::AppStrategy;
/// use etcetera::app_strategy::AppStrategyArgs;
/// use etcetera::app_strategy::Unix;
/// use std::path::Path;
///
/// let app_strategy = Unix::new(AppStrategyArgs {
///     top_level_domain: "org".to_string(),
///     author: "Acme Corp".to_string(),
///     app_name: "Frobnicator Plus".to_string(),
/// }).unwrap();
///
/// let home_dir = etcetera::home_dir().unwrap();
///
/// assert_eq!(
///     app_strategy.home_dir(),
///     &home_dir
/// );
/// assert_eq!(
///     app_strategy.config_dir().strip_prefix(&home_dir),
///     Ok(Path::new(".frobnicator-plus/"))
/// );
/// assert_eq!(
///     app_strategy.data_dir().strip_prefix(&home_dir),
///     Ok(Path::new(".frobnicator-plus/data/"))
/// );
/// assert_eq!(
///     app_strategy.cache_dir().strip_prefix(&home_dir),
///     Ok(Path::new(".frobnicator-plus/cache/"))
/// );
/// assert_eq!(
///     app_strategy.state_dir().unwrap().strip_prefix(&home_dir),
///     Ok(Path::new(".frobnicator-plus/state/"))
/// );
/// assert_eq!(
///     app_strategy.runtime_dir().unwrap().strip_prefix(&home_dir),
///     Ok(Path::new(".frobnicator-plus/runtime/"))
/// );
/// ```
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Unix {
    // This is `.frobnicator-plus` in the above example.
    home_dir: PathBuf,
    unixy_name: String,
}

impl Unix {
    /// Create a new Unix AppStrategy
    pub fn new(args: super::AppStrategyArgs) -> Result<Self, HomeDirError> {
        Ok(Self {
            home_dir: crate::home_dir()?,
            unixy_name: format!(".{}", args.unixy_name()),
        })
    }
}

impl super::AppStrategy for Unix {
    fn home_dir(&self) -> &Path {
        &self.home_dir
    }

    fn config_dir(&self) -> PathBuf {
        self.home_dir.join(&self.unixy_name)
    }

    fn data_dir(&self) -> PathBuf {
        self.home_dir.join(&self.unixy_name).join("data/")
    }

    fn cache_dir(&self) -> PathBuf {
        self.home_dir.join(&self.unixy_name).join("cache/")
    }

    fn state_dir(&self) -> Option<PathBuf> {
        Some(self.home_dir.join(&self.unixy_name).join("state/"))
    }

    fn runtime_dir(&self) -> Option<PathBuf> {
        Some(self.home_dir.join(&self.unixy_name).join("runtime/"))
    }
}