rimrs 0.1.4

RimWorld mod manager
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use crate::{
    helpers::{config::get_config_dir, paths::push_mods_config_path},
    serialization::ini::{INIError, INIReader},
    traits::LogIfErr,
};
use std::{
    collections::HashMap,
    path::{Path, PathBuf},
};
use thiserror::Error;

#[allow(clippy::module_name_repetitions)]
#[derive(Debug, Clone, Default)]
pub struct RimPyConfig {
    pub colors: Option<HashMap<String, String>>,
    pub folders: RimPyConfigFolders,
    pub startup_params: Option<String>,
}

#[derive(Debug, Clone, Default)]
pub struct RimPyConfigFolders {
    pub config_folder: Option<PathBuf>,
    pub game_folder: Option<PathBuf>,
    pub local_mods: Option<PathBuf>,
    pub expansions: Option<PathBuf>,
    pub steam_mods: Option<PathBuf>,
    pub steamcmd: Option<PathBuf>,
}

impl RimPyConfigFolders {
    #[must_use]
    pub fn mods_config_path(&self) -> Option<PathBuf> {
        get_config_dir().log_if_err().map(push_mods_config_path)
    }
}

impl RimPyConfig {
    /// Tries to read the rimpy config from its `config.ini` file.
    ///
    /// # Errors
    /// * If it can't find the `config.ini` file in the first place
    /// * If it can't open the file (e.g. doesn't exist, perms)
    /// * If it can't parse that file as INI-syntax
    pub fn from_file() -> Result<Self, ReadRimPyConfigError> {
        Self::try_from(INIReader::from_rimpy_config_ini()?).map_err(Into::into)
    }

    /// Tries to read the rimpy config from a given path.
    ///
    /// # Errors
    /// * If it can't open the file (e.g. doesn't exist, perms)
    /// * If it can't parse that file as INI-syntax
    pub fn from_path<P: AsRef<Path>>(path: P) -> Result<Self, INIError> {
        Self::try_from(INIReader::new(path).map_err(INIError::IOError)?).map_err(Into::into)
    }

    #[must_use]
    pub fn mods_config_path(&self) -> Option<PathBuf> {
        self.folders.mods_config_path()
    }
}

impl TryFrom<INIReader<'_>> for RimPyConfig {
    type Error = INIError;
    fn try_from(reader: INIReader<'_>) -> Result<Self, INIError> {
        let mut conf = Self::default();
        let mut colors = HashMap::new();

        for kvp in reader {
            let kvp = kvp?; // kinda annoying
            match kvp.section.as_deref() {
                Some("Folders") => match kvp.key.as_str() {
                    "Config folder" => conf.folders.config_folder = Some(PathBuf::from(kvp.value)),
                    "Game folder" => conf.folders.game_folder = Some(PathBuf::from(kvp.value)),
                    "Local mods" => conf.folders.local_mods = Some(PathBuf::from(kvp.value)),
                    "Expansions" => conf.folders.expansions = Some(PathBuf::from(kvp.value)),
                    "Steam mods" => conf.folders.steam_mods = Some(PathBuf::from(kvp.value)),
                    "SteamCMD" => conf.folders.steamcmd = Some(PathBuf::from(kvp.value)),
                    _ => {}
                },
                Some("Colors") => {
                    colors.insert(kvp.key, kvp.value);
                }
                Some("StartupParams") => {
                    conf.startup_params = Some(kvp.value);
                }
                _ => {}
            }
        }

        if !colors.is_empty() {
            conf.colors = Some(colors);
        }

        Ok(conf)
    }
}

#[derive(Debug, Error)]
pub enum ReadRimPyConfigError {
    #[error("couldn't read env variable: {0}")]
    VarError(#[from] std::env::VarError),
    #[error("{0}")]
    INIError(#[from] crate::serialization::ini::INIError),
}