tweep 0.3.0

Parser for the Twee v3 interactive fiction format
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

use crate::ErrorKind;
use crate::Context;

/// An error with an owned [`ErrorKind`] and [`Position`]
///
/// [`ErrorKind`]: enum.ErrorKind.html
/// [`Position`]: enum.Position.html
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Error {
    /// The type of error
    pub kind: ErrorKind,

    /// The context of the error
    pub context: Option<Context>,
}

impl Error {
    /// Creates a new `Error` with the given [`ErrorKind`] and a default
    /// [`Position`]
    ///
    /// # Examples
    /// ```
    /// use tweep::{Error, ErrorKind};
    /// # use tweep::{FullContext};
    /// # let context = FullContext::from(None, "::".to_string());
    /// let error = Error::new(ErrorKind::EmptyName, Some(context));
    /// # assert_eq!(error.kind, ErrorKind::EmptyName);
    /// ```
    ///
    /// [`ErrorKind`]: enum.ErrorKind.html
    /// [`Position`]: struct.Position.html
    pub fn new<T: Into<Context>>(kind: ErrorKind, context: Option<T>) -> Self {
        Error {
            kind,
            context: context.map(|t| t.into()),
        }
    }
}

#[cfg(feature = "issue-names")]
impl Error {
    /// Gets a string representation of a `Error`'s `ErrorKind` variant name
    ///
    /// Enabled with "issue-names" feature
    pub fn get_name(&self) -> &str {
        self.kind.get_name()
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        None
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{} at {:?}", self.kind, self.context)
    }
}