mxp 1.2.1

Rust implementation of the MXP (Mud eXtension Protocol) standard
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

use std::fmt;

use flagset::FlagSet;

use crate::arguments::{ArgumentScanner, ExpectArg, FromArgs};
use crate::keyword::EntityKeyword;
use crate::node::EntityDefinition;

/// The `<VAR>` tag is just like the `<!ENTITY>` tag, except that the value of the variable is
/// placed between the `<VAR>` and `</VAR>` tags, and this value is displayed to the user.
///
/// # Examples
///
/// ```
/// use mxp::entity::EntityKeyword;
///
/// assert_eq!(
///     "<VAR Hp DESC=Health PUBLISH>".parse::<mxp::Var>(),
///     Ok(mxp::Var {
///         name: "Hp".into(),
///         desc: Some("Health".into()),
///         keywords: EntityKeyword::Publish.into(),
///     }),
/// );
/// ```
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct Var<S = String> {
    /// Variable name.
    pub name: S,
    /// Variable description.
    pub desc: Option<S>,
    /// Keywords.
    pub keywords: FlagSet<EntityKeyword>,
}

impl<S> Var<S> {
    /// Applies a type transformation to all text, returning a new struct.
    pub fn map_text<T, F>(self, mut f: F) -> Var<T>
    where
        F: FnMut(S) -> T,
    {
        Var {
            name: f(self.name),
            desc: self.desc.map(f),
            keywords: self.keywords,
        }
    }
}

impl_into_owned!(Var);

impl<S: AsRef<str>> Var<S> {
    /// Returns a new struct that borrows text from this one.
    pub fn borrow_text(&self) -> Var<&str> {
        Var {
            name: self.name.as_ref(),
            desc: self.desc.as_ref().map(AsRef::as_ref),
            keywords: self.keywords,
        }
    }

    /// Creates an `EntityDefinition` from properties and a value.
    pub fn with_value<'a>(&'a self, value: &'a str) -> EntityDefinition<'a> {
        EntityDefinition {
            name: self.name.as_ref(),
            desc: self.desc.as_ref().map(AsRef::as_ref),
            keywords: self.keywords,
            value,
        }
    }
}

impl_partial_eq!(Var);

impl<'a, S: AsRef<str>> FromArgs<'a, S> for Var<S> {
    fn from_args<A: ArgumentScanner<'a, Decoded = S>>(scanner: A) -> crate::Result<Self> {
        let mut scanner = scanner.with_keywords();
        let variable = scanner.get_next()?.expect_some("Variable")?;
        let desc = scanner.get_next_or("desc")?;
        let keywords = scanner.into_keywords()?;
        Ok(Self {
            name: variable,
            desc,
            keywords,
        })
    }
}

impl<S> From<S> for Var<S> {
    fn from(name: S) -> Self {
        Self {
            name,
            desc: None,
            keywords: FlagSet::empty(),
        }
    }
}

impl_from_str!(Var);

impl<S: AsRef<str>> fmt::Display for Var<S> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let Var {
            name,
            desc,
            keywords,
        } = self.borrow_text().map_text(crate::display::Escape);
        write!(f, "<VAR {name}")?;
        if let Some(desc) = desc {
            write!(f, " {desc}")?;
        }
        for keyword in keywords {
            write!(f, " {keyword}")?;
        }
        f.write_str(">")
    }
}