viks 1.0.5

vim-like key crate
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

type Format = String;
type Cause = String;

#[derive(Debug)]
/// viks error type.
///
/// # Example
///
/// ```
/// # use viks::Key;
///
/// let key = Key::new("A");
///
/// if let Err(err) = key {
///     eprintln!("incorrect syntax: {}", err);
/// }
/// ```
pub struct Error(Format, Cause);

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

impl Error {
    pub(crate) fn new(format: &str, cause: &str) -> Self {
        Self(format.to_string(), cause.to_string())
    }

    /// Get format of Error.
    ///
    /// # Example
    /// ```
    /// # use viks::Key;
    /// # fn main() {
    /// let key = Key::new("<ES");
    ///
    /// if let Err(e) = key {
    ///     println!("{}", e.format());
    /// }
    /// # }
    /// ```
    pub fn format(&self) -> &str {
        &self.0
    }

    /// Get error cause.
    ///
    /// # Example
    /// ```
    /// # use viks::Key;
    /// # fn main() {
    /// let key = Key::new("<ES");
    ///
    /// if let Err(e) = key {
    ///     println!("{}", e.cause());
    /// }
    /// # }
    /// ```
    pub fn cause(&self) -> &str {
        &self.1
    }
}

impl std::error::Error for Error {}

/// viks result alias.
pub type Result<T> = std::result::Result<T, Error>;