openmw-config 1.0.0

A library for interacting with the Openmw Configuration system.
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

// SPDX-License-Identifier: MIT OR Apache-2.0
// Copyright (c) 2025 Dave Corley (S3kshun8)

use crate::{GameSetting, GameSettingMeta};
use std::fmt;

#[derive(Debug, Clone)]
pub struct GenericSetting {
    meta: GameSettingMeta,
    key: String,
    value: String,
}

impl GameSetting for GenericSetting {
    fn meta(&self) -> &GameSettingMeta {
        &self.meta
    }
}

impl fmt::Display for GenericSetting {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}{}={}", self.meta.comment, self.key, self.value)
    }
}

impl GenericSetting {
    pub fn new(
        key: &str,
        value: &str,
        source_config: &std::path::Path,
        comment: &mut String,
    ) -> Self {
        Self {
            meta: GameSettingMeta {
                source_config: source_config.to_path_buf(),
                comment: std::mem::take(comment),
            },
            key: key.to_string(),
            value: value.to_string(),
        }
    }
}

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

    #[test]
    fn test_new_consumes_comment_and_tracks_source() {
        let source = PathBuf::from("/tmp/openmw.cfg");
        let mut comment = String::from("# heading\n");

        let setting = GenericSetting::new("unknown-key", "value", &source, &mut comment);

        assert_eq!(setting.meta().source_config, source);
        assert_eq!(setting.meta().comment, "# heading\n");
        assert!(comment.is_empty());
    }

    #[test]
    fn test_display_emits_comment_and_pair() {
        let source = PathBuf::from("/tmp/openmw.cfg");
        let mut comment = String::from("# comment\n");

        let setting = GenericSetting::new("foo", "bar", &source, &mut comment);
        assert_eq!(setting.to_string(), "# comment\nfoo=bar");
    }
}