mxp 1.2.0

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

use std::fmt;

use crate::arguments::{ArgumentScanner, ExpectArg, FromArgs};

/// A MUD sets a style-sheet version number by sending the `<VERSION styleversion>` tag to the
/// client.
///
/// The client caches this version information and returns it when requested by a plain
/// `<VERSION>` request.
///
/// See [MXP specification: `<VERSION>`](https://www.zuggsoft.com/zmud/mxp.htm#Version%20Control).
///
/// # Examples
///
/// ```
/// assert_eq!(
///     "<VERSION 0.6>".parse::<mxp::StyleVersion>(),
///     Ok(mxp::StyleVersion {
///         styleversion: "0.6".into(),
///     }),
/// );
/// ```
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct StyleVersion<S = String> {
    /// Style-sheet version number.
    pub styleversion: S,
}

impl<S> StyleVersion<S> {
    /// Applies a type transformation to all text, returning a new struct.
    pub fn map_text<T, F>(self, f: F) -> StyleVersion<T>
    where
        F: FnOnce(S) -> T,
    {
        StyleVersion {
            styleversion: f(self.styleversion),
        }
    }
}

impl_into_owned!(StyleVersion);

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

impl_partial_eq!(StyleVersion);

impl<'a, S: AsRef<str>> FromArgs<'a, S> for StyleVersion<S> {
    fn from_args<A: ArgumentScanner<'a, Decoded = S>>(mut scanner: A) -> crate::Result<Self> {
        let styleversion = scanner.get_next()?.expect_some("StyleVersion")?;
        scanner.expect_end()?;
        Ok(Self { styleversion })
    }
}

impl_from_str!(StyleVersion);

impl<S: AsRef<str>> fmt::Display for StyleVersion<S> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let StyleVersion { styleversion } = self.borrow_text();
        crate::display::ElementFormatter {
            name: "VERSION",
            arguments: &[&styleversion],
            keywords: &[],
        }
        .fmt(f)
    }
}