tty-interface 2.0.0

Provides simple TTY-based interface capabilities including partial re-renders of multi-line displays.
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

//! Provides common result and error types for TTY Interface.

use std::{fmt, error};
use std::fmt::Formatter;
use std::error::Error;

/// A specialized result type encompassing errors from the tty-interface crate and `std::io`.
pub type Result<T> = std::result::Result<T, TTYError>;

/// A specialized error type encompassing tty-interface and `std::io::Error` errors.
#[derive(Debug)]
pub enum TTYError {
    LineOutOfBounds,
    SegmentOutOfBounds,
    CursorOutOfBounds,
    IO(std::io::Error),
}

impl fmt::Display for TTYError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match *self {
            TTYError::LineOutOfBounds => write!(f, "line update references out-of-bounds index"),
            TTYError::SegmentOutOfBounds => write!(f, "segment update references out-of-bounds index"),
            TTYError::CursorOutOfBounds => write!(f, "cursor update is invalid/out-of-bounds"),
            TTYError::IO(..) => write!(f, "failure while attempting to render updates"),
        }
    }
}

impl Error for TTYError {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match *self {
            TTYError::LineOutOfBounds => None,
            TTYError::SegmentOutOfBounds => None,
            TTYError::CursorOutOfBounds => None,
            TTYError::IO(ref e) => Some(e),
        }
    }
}

impl From<std::io::Error> for TTYError {
    fn from(err: std::io::Error) -> TTYError {
        TTYError::IO(err)
    }
}