dfraw_json_parser 0.17.5

Library which parses Dwarf Fortress raw files into JSON
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
106
107
108
109
110
111
112
113

use serde::{Deserialize, Serialize};

/// The additional data specific to the steam workshop
#[derive(Serialize, Deserialize, Default, Clone, Debug, specta::Type)]
#[serde(rename_all = "camelCase")]
pub struct SteamData {
    #[serde(skip_serializing_if = "Option::is_none")]
    title: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tags: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    key_value_tags: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    metadata: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    changelog: Option<String>,
    file_id: u64,
}

impl SteamData {
    /// Returns whether the steam data is empty
    ///
    /// # Returns
    ///
    /// * `true` if the steam data is empty, `false` otherwise.
    #[allow(dead_code)]
    #[must_use]
    pub const fn is_empty(&self) -> bool {
        self.title.is_none()
            && self.description.is_none()
            && self.tags.is_none()
            && self.key_value_tags.is_none()
            && self.metadata.is_none()
            && self.changelog.is_none()
            && self.file_id == 0
    }
    /// Sets the title of the steam data
    ///
    /// # Arguments
    ///
    /// * `title` - The title to set
    pub fn set_title(&mut self, title: &str) {
        self.title = Some(String::from(title));
    }
    /// Sets the description of the steam data
    ///
    /// # Arguments
    ///
    /// * `description` - The description to set
    pub fn set_description(&mut self, description: &str) {
        self.description = Some(String::from(description));
    }
    /// Sets the changelog of the steam data
    ///
    /// # Arguments
    ///
    /// * `changelog` - The changelog to set
    pub fn set_changelog(&mut self, changelog: &str) {
        self.changelog = Some(String::from(changelog));
    }
    /// Sets the file id of the steam data
    ///
    /// # Arguments
    ///
    /// * `file_id` - The file id to set
    pub fn set_file_id(&mut self, file_id: u64) {
        self.file_id = file_id;
    }
    /// Adds a tag to the steam data
    ///
    /// # Arguments
    ///
    /// * `tag` - The tag to add
    pub fn add_tag(&mut self, tag: &str) {
        if self.tags.is_none() {
            self.tags = Some(Vec::new());
        }

        if let Some(tags) = &mut self.tags {
            tags.push(String::from(tag));
        }
    }
    /// Adds a key value tag to the steam data
    ///
    /// # Arguments
    ///
    /// * `tag` - The key and value to add
    pub fn add_key_value_tag(&mut self, tag: &str) {
        if self.key_value_tags.is_none() {
            self.key_value_tags = Some(Vec::new());
        }

        if let Some(tags) = &mut self.key_value_tags {
            tags.push(String::from(tag));
        }
    }
    /// Adds metadata to the steam data
    ///
    /// # Arguments
    ///
    /// * `metadata` - The metadata to add
    pub fn add_metadata(&mut self, metadata: &str) {
        if self.metadata.is_none() {
            self.metadata = Some(Vec::new());
        }

        if let Some(self_metadata) = &mut self.metadata {
            self_metadata.push(String::from(metadata));
        }
    }
}