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

use std::{fmt, slice, vec};

use flagset::FlagSet;

use crate::arguments::{ArgumentScanner, FromArgs};
use crate::element::ActionKind;
use crate::responses::SupportResponse;

/// Determines exactly which tags are supported by the client.
///
/// See [MXP specification: `<SUPPORT>`](https://www.zuggsoft.com/zmud/mxp.htm#Version%20Control).
///
/// # Examples
///
/// ```
/// assert_eq!(
///     "<SUPPORT 'color.*' send.expire image>".parse::<mxp::Support>(),
///     Ok(mxp::Support {
///         questions: vec!["color.*".into(), "send.expire".into(), "image".into()],
///     }),
/// );
/// ```
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct Support<S = String> {
    pub questions: Vec<S>,
}

impl<S> Support<S> {
    /// Applies a type transformation to all text, returning a new struct.
    pub fn map_text<T, F>(self, f: F) -> Support<T>
    where
        F: FnMut(S) -> T,
    {
        Support {
            questions: self.questions.into_iter().map(f).collect(),
        }
    }

    /// Alias for `self.questions.iter()`.
    pub fn iter(&self) -> slice::Iter<'_, S> {
        self.questions.iter()
    }

    /// Constructs a `SupportResponse` from this struct's questions.
    pub fn respond(&self, supported: FlagSet<ActionKind>) -> SupportResponse<slice::Iter<'_, S>>
    where
        S: AsRef<str>,
    {
        SupportResponse::new(self.questions.iter(), supported)
    }
}

impl_into_owned!(Support);

impl<S> IntoIterator for Support<S> {
    type Item = S;

    type IntoIter = vec::IntoIter<S>;

    fn into_iter(self) -> Self::IntoIter {
        self.questions.into_iter()
    }
}

impl<'a, S> IntoIterator for &'a Support<S> {
    type Item = &'a S;

    type IntoIter = slice::Iter<'a, S>;

    fn into_iter(self) -> Self::IntoIter {
        self.questions.iter()
    }
}

impl<'a, S: AsRef<str>> FromArgs<'a, S> for Support<S> {
    fn from_args<A: ArgumentScanner<'a, Decoded = S>>(mut scanner: A) -> crate::Result<Self> {
        let mut questions = Vec::new();
        while let Some(question) = scanner.get_next()? {
            questions.push(question);
        }
        Ok(Self { questions })
    }
}

impl_from_str!(Support);

impl<S: AsRef<str>> fmt::Display for Support<S> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let Support { questions } = self;
        if questions.is_empty() {
            return f.write_str("<SUPPORT>");
        }
        f.write_str("<SUPPORT")?;
        for question in questions {
            write!(f, " \"{}\"", question.as_ref())?;
        }
        f.write_str(">")
    }
}