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

use crate::{ModMetaData, RimPyConfig};
use std::{
    collections::HashMap,
    fs::{self, DirEntry},
    io,
    path::PathBuf,
    sync::{Arc, Mutex},
};

#[non_exhaustive]
#[derive(Debug, Clone, Default)]
pub struct ModList {
    pub mods: Arc<Mutex<HashMap<String, ModMetaData>>>,
}

impl ModList {
    /// Looks for `*/About/About.xml` files in the given dirs, then parses them.
    ///
    /// # Errors
    /// * [`fs::read_dir`] fails on one of the given dirs
    pub fn from_dirs(dirs: impl IntoIterator<Item = PathBuf>) -> Result<Self, io::Error> {
        let mut paths = Vec::new();
        for dir in dirs {
            for mod_dir in fs::read_dir(dir)? {
                if let Ok(p) = mod_dir.as_ref().map(DirEntry::path) {
                    if mod_dir
                        .and_then(|md| md.file_type())
                        .map_or(false, |ft| ft.is_dir())
                    {
                        paths.push(p);
                    }
                }
            }
        }

        for path in &mut paths {
            path.push("About");
            path.push("About.xml");
        }
        paths.retain(|path| path.exists());
        let mods: Vec<_> = paths
            .into_iter()
            .filter_map(|path| ModMetaData::read(path).ok())
            .collect();
        Ok(ModList::from(mods))
    }

    /// Gets the package ids (lowercase) of all mods in the mod list.
    /// Returns `None` if there is a [`std::sync::PoisonError`].
    #[must_use]
    pub fn package_ids(&self) -> Option<Vec<String>> {
        self.mods
            .lock()
            .ok()
            .map(|map| map.keys().map(String::clone).collect())
    }
}

impl<I: IntoIterator<Item = ModMetaData>> From<I> for ModList {
    fn from(mods_iter: I) -> Self {
        let mods: HashMap<String, ModMetaData> = mods_iter
            .into_iter()
            .filter_map(|m| m.packageId.clone().map(|pid| (pid.to_lowercase(), m)))
            .collect();

        ModList {
            mods: Arc::new(Mutex::new(mods)),
        }
    }
}

impl TryFrom<&RimPyConfig> for ModList {
    type Error = io::Error;

    fn try_from(rimpy_config: &RimPyConfig) -> Result<Self, Self::Error> {
        let mut paths = Vec::new();

        if let Some(p) = &rimpy_config.folders.expansions {
            paths.push(p.clone());
        }
        if let Some(p) = &rimpy_config.folders.steam_mods {
            paths.push(p.clone());
        }
        if let Some(p) = &rimpy_config.folders.local_mods {
            paths.push(p.clone());
        }

        ModList::from_dirs(paths)
    }
}