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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

use std::fmt;

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

/// Opens a web page in the user's web browser.
///
/// See [MXP specification: `<A>`](https://www.zuggsoft.com/zmud/mxp.htm#Links).
///
/// # Examples
///
/// ```
/// assert_eq!(
///     "<A 'http://github.com' EXPIRE=all>".parse::<mxp::Hyperlink>(),
///     Ok(mxp::Hyperlink {
///         href: "http://github.com".into(),
///         hint: "http://github.com".into(),
///         expire: Some("all".into()),
///     }),
/// );
///
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct Hyperlink<S = String> {
    /// Link to open.
    pub href: S,
    /// Mouseover hint.
    pub hint: S,
    /// Optional scope for the link. If defined, an [`Expire`](crate::Expire) command can
    /// invalidate the link.
    pub expire: Option<S>,
}

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

impl_into_owned!(Hyperlink);

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

impl_partial_eq!(Hyperlink);

impl<'a, S: AsRef<str> + Clone> FromArgs<'a, S> for Hyperlink<S> {
    fn from_args<A: ArgumentScanner<'a, Decoded = S>>(mut scanner: A) -> crate::Result<Self> {
        let href = scanner.get_next_or("href")?.expect_some("href")?;
        let hint = scanner.get_next_or("hint")?.unwrap_or_else(|| href.clone());
        let expire = scanner.get_next_or("expire")?;
        scanner.expect_end()?;
        Ok(Self { href, hint, expire })
    }
}

impl_from_str!(Hyperlink);

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