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

use std::fmt;

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

/// Closes the current MUD connection and causes a new connect to open on a new server.
///
/// See [MXP specification: `<RELOCATE>`](https://www.zuggsoft.com/zmud/mxp.htm#Crosslinking%20multiple%20MUD%20servers).
///
/// # Examples
///
/// ```
/// assert_eq!(
///     "<RELOCATE new.server.com 1000>".parse::<mxp::Relocate>(),
///     Ok(mxp::Relocate {
///         hostname: "new.server.com".into(),
///         port: 1000,
///         quiet: false,
///     }),
/// );
/// ```
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct Relocate<S = String> {
    /// Hostname of the new connection.
    pub hostname: S,
    /// Port of the new connection.
    pub port: u16,
    /// The optional keyword QUIET can be used to suppress further output from the MUD.
    /// When the closing `</RELOCATE>` tag is used, MUD output is resumed.
    pub quiet: bool,
}

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

impl_into_owned!(Relocate);

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

impl_partial_eq!(Relocate);

impl<'a, S: AsRef<str>> FromArgs<'a, S> for Relocate<S> {
    fn from_args<A: ArgumentScanner<'a, Decoded = S>>(scanner: A) -> crate::Result<Self> {
        let mut scanner = scanner.with_keywords();
        let hostname = scanner.get_next()?.expect_some("Hostname")?;
        let port = scanner.get_next()?.expect_number()?.expect_some("Port")?;
        let keywords = scanner.into_keywords()?;
        Ok(Self {
            hostname,
            port,
            quiet: keywords.contains(RelocateKeyword::Quiet),
        })
    }
}

impl_from_str!(Relocate);

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