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

use std::fmt;
use std::str::FromStr;

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

/// Sets the color of the text.
///
/// See [MXP specification: `<COLOR>`](https://www.zuggsoft.com/zmud/mxp.htm#Text%20Formatting).
///
/// # Examples
///
/// ```
/// use mxp::RgbColor;
///
/// assert_eq!(
///     "<COLOR FORE=red BACK=#123456>".parse::<mxp::Color>(),
///     Ok(mxp::Color {
///         fore: Some(RgbColor::hex(0xFF0000)),
///         back: Some(RgbColor::hex(0x123456)),
///     }),
/// );
/// ```
#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
pub struct Color {
    /// If defined, sets the foreground color of the text.
    pub fore: Option<RgbColor>,
    /// If defined, sets the background color of the text.
    pub back: Option<RgbColor>,
}

impl<'a, S: AsRef<str>> FromArgs<'a, S> for Color {
    fn from_args<A: ArgumentScanner<'a, Decoded = S>>(mut scanner: A) -> crate::Result<Self> {
        let fore = scanner.get_next_or("fore")?.expect_color()?;
        let back = scanner.get_next_or("back")?.expect_color()?;
        scanner.expect_end()?;
        Ok(Self { fore, back })
    }
}

impl From<RgbColor> for Color {
    /// Constructs a `<COLOR>` with the specified color as its foreground, and no background color.
    fn from(fore: RgbColor) -> Self {
        Self {
            fore: Some(fore),
            ..Default::default()
        }
    }
}

impl<'a> TryFrom<&'a str> for Color {
    type Error = crate::parse::FromStrError;

    #[inline]
    fn try_from(s: &'a str) -> Result<Self, Self::Error> {
        crate::parse::parse_element(s)
    }
}
impl FromStr for Color {
    type Err = crate::parse::FromStrError;

    #[inline]
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        crate::parse::parse_element::<Color>(s)
    }
}

impl fmt::Display for Color {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let Color { fore, back } = self;
        crate::display::ElementFormatter {
            name: "COLOR",
            arguments: &[fore, back],
            keywords: &[],
        }
        .fmt(f)
    }
}