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

use serde::{Deserialize, Serialize};

use crate::parser::serializer_helper;

use super::tokens::CreatureEffectProperty;

/// A creature effect.
#[derive(Serialize, Deserialize, Debug, Clone, Default)]
#[serde(rename_all = "camelCase")]
pub struct CreatureEffect {
    severity: u32,
    probability: u8,

    #[serde(skip_serializing_if = "Option::is_none")]
    affected_body_parts_by_category: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    affected_body_parts_by_type: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    affected_body_parts_by_token: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    tags: Option<Vec<CreatureEffectProperty>>,

    start: u32,
    peak: u32,
    end: u32,

    #[serde(skip_serializing_if = "Option::is_none")]
    dwf_stretch: Option<u8>,
}

impl CreatureEffect {
    /// Function to "clean" the creature. This is used to remove any empty list or strings,
    /// and to remove any default values. By "removing" it means setting the value to None.
    ///
    /// This also will remove the metadata if `is_metadata_hidden` is true.
    ///
    /// Steps:
    /// - Set any metadata to None if `is_metadata_hidden` is true.
    /// - Set any empty string to None.
    /// - Set any empty list to None.
    /// - Set any default values to None.
    #[must_use]
    pub fn cleaned(&self) -> Self {
        let mut cleaned = self.clone();

        // Set any empty string to None.
        if let Some(affected_body_parts_by_category) =
            cleaned.affected_body_parts_by_category.clone()
        {
            if affected_body_parts_by_category.is_empty() {
                cleaned.affected_body_parts_by_category = None;
            }
        }

        // Set any empty string to None.
        if let Some(affected_body_parts_by_type) = cleaned.affected_body_parts_by_type.clone() {
            if affected_body_parts_by_type.is_empty() {
                cleaned.affected_body_parts_by_type = None;
            }
        }

        // Set any empty string to None.
        if let Some(affected_body_parts_by_token) = cleaned.affected_body_parts_by_token.clone() {
            if affected_body_parts_by_token.is_empty() {
                cleaned.affected_body_parts_by_token = None;
            }
        }

        // Set any empty string to None.
        if let Some(tags) = cleaned.tags.clone() {
            if tags.is_empty() {
                cleaned.tags = None;
            }
        }

        // Set any default values to None.
        if serializer_helper::is_zero_u8(cleaned.dwf_stretch) {
            cleaned.dwf_stretch = None;
        }

        cleaned
    }
}