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

use std::fmt;

/// The error type returned when a conversion from a sum type to a specific node type fails.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct TryFromNodeError {
    pub(crate) prefix: &'static str,
    pub(crate) expected: &'static str,
    pub(crate) got: &'static str,
}

impl TryFromNodeError {
    /// The type that was requested for conversion.
    ///
    /// # Examples
    ///
    /// ```
    /// use mxp::node::{Tag, TagClose, TagOpen};
    ///
    /// let node = Tag::Close(TagClose { name: "a" });
    /// let err = TagOpen::try_from(node).unwrap_err();
    /// assert_eq!(err.expected_type(), "Tag::Open");
    /// ```
    pub fn expected_type(&self) -> String {
        format!("{}::{}", self.prefix, self.expected)
    }

    /// The actual type that was found.
    ///
    /// # Examples
    ///
    /// ```
    /// use mxp::node::{Tag, TagClose, TagOpen};
    ///
    /// let node = Tag::Close(TagClose { name: "a" });
    /// let err = TagOpen::try_from(node).unwrap_err();
    /// assert_eq!(err.received_type(), "Tag::Close");
    /// ```
    pub fn received_type(&self) -> String {
        format!("{}::{}", self.prefix, self.got)
    }
}

impl fmt::Display for TryFromNodeError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let Self {
            prefix,
            expected,
            got,
        } = self;
        write!(f, "expected {prefix}::{expected}, got {prefix}::{got}")
    }
}