arma-rs 1.12.1

Arma 3 Extensions in Rust
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use std::fmt::Display;

mod features;
mod from_arma;
mod into_arma;
pub mod loadout;

pub use from_arma::{FromArma, FromArmaError};
pub use into_arma::{DirectReturn, IntoArma};

#[derive(Debug, Clone, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(untagged))]
/// A value that can be converted to and from Arma types.
pub enum Value {
    /// Arma's `nil` value.
    /// Represented as `null`
    Null,
    /// Arma's `number` value.
    Number(f64),
    /// Arma's `array` value.
    /// Represented as `[...]`
    Array(Vec<Self>),
    /// Arma's `boolean` value.
    /// Represented as `true` or `false`
    Boolean(bool),
    /// Arma's `string` value.
    /// Represented as `"..."`
    ///
    /// Note: Arma escapes quotes with two double quotes.
    /// This conversation will remove one step of escaping.
    /// Example: `"My name is ""John""."` will become `My name is "John".`
    String(String),
    /// Unknown value. Contains the raw string.
    Unknown(String),
}

impl Display for Value {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Null => write!(f, "null"),
            Self::Number(n) => write!(f, "{n}"),
            Self::Array(a) => write!(
                f,
                "[{}]",
                a.iter()
                    .map(ToString::to_string)
                    .collect::<Vec<String>>()
                    .join(",")
            ),
            Self::Boolean(b) => write!(f, "{b}"),
            Self::String(s) => write!(f, "\"{}\"", s.replace('\"', "\"\"")),
            Self::Unknown(s) => write!(f, "Unknown({s})"),
        }
    }
}

impl FromArma for Value {
    fn from_arma(s: String) -> Result<Self, FromArmaError> {
        match s.chars().next() {
            Some('n') => Ok(Self::Null),
            Some('t' | 'f') => Ok(Self::Boolean(<bool>::from_arma(s)?)),
            Some('0'..='9' | '-') => Ok(Self::Number(<f64>::from_arma(s)?)),
            Some('[') => Ok(Self::Array(<Vec<Self>>::from_arma(s)?)),
            Some('"') => Ok(Self::String(<String>::from_arma(s)?)),
            _ => Ok(Self::Unknown(s)),
        }
    }
}

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

    #[test]
    fn test_value_display() {
        assert_eq!(Value::Null.to_string(), "null");
        assert_eq!(Value::Number(1.0).to_string(), "1");
        assert_eq!(Value::Number(1.5).to_string(), "1.5");
        assert_eq!(Value::Number(-1.5).to_string(), "-1.5");
        assert_eq!(Value::Boolean(true).to_string(), "true");
        assert_eq!(Value::Boolean(false).to_string(), "false");
        assert_eq!(Value::String(String::new()).to_string(), "\"\"");
        assert_eq!(Value::String(" ".to_string()).to_string(), "\" \"");
        assert_eq!(Value::String("Hello".to_string()).to_string(), "\"Hello\"");
        assert_eq!(
            Value::String("Hello \"World\"".to_string()).to_string(),
            "\"Hello \"\"World\"\"\""
        );
        assert_eq!(
            Value::Array(vec![
                Value::Number(1.0),
                Value::Number(2.0),
                Value::Number(3.0)
            ])
            .to_string(),
            "[1,2,3]"
        );
        assert_eq!(
            Value::Array(vec![
                Value::String("Hello".to_string()),
                Value::String("World".to_string())
            ])
            .to_string(),
            "[\"Hello\",\"World\"]"
        );
    }

    #[test]
    fn value_from_arma() {
        let value = Value::from_arma("null".to_string()).unwrap();
        assert_eq!(value, Value::Null);
        let value = Value::from_arma("true".to_string()).unwrap();
        assert_eq!(value, Value::Boolean(true));
        let value = Value::from_arma("false".to_string()).unwrap();
        assert_eq!(value, Value::Boolean(false));
        let value = Value::from_arma("1".to_string()).unwrap();
        assert_eq!(value, Value::Number(1.0));
        let value = Value::from_arma("1.5".to_string()).unwrap();
        assert_eq!(value, Value::Number(1.5));
        let value = Value::from_arma("-1.5".to_string()).unwrap();
        assert_eq!(value, Value::Number(-1.5));
        let value = Value::from_arma("[1,2,3]".to_string()).unwrap();
        assert_eq!(
            value,
            Value::Array(vec![
                Value::Number(1.0),
                Value::Number(2.0),
                Value::Number(3.0)
            ])
        );
        let value = Value::from_arma("[\"Hello\",\"World\"]".to_string()).unwrap();
        assert_eq!(
            value,
            Value::Array(vec![
                Value::String("Hello".to_string()),
                Value::String("World".to_string())
            ])
        );
        let value = Value::from_arma("\"Hello\"".to_string()).unwrap();
        assert_eq!(value, Value::String("Hello".to_string()));
        let value = Value::from_arma("\"Hello \"\"World\"\"\"".to_string()).unwrap();
        assert_eq!(value, Value::String("Hello \"World\"".to_string()));
    }
}