cnsl 0.1.3

A crate that provides methods and macros for interacting with the command line.
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

//! A module for error handling.
use std::fmt::Display;

#[deprecated = "Use `cnsl::error::RawPanics` instead."]
pub trait Panics<T, E> : RawPanics<T, E> {
}

/// A trait for expecting a value, and panicking with the raw message if it is not present.
pub trait RawPanics<T, E> {
    /// Consumes `self`, then returns the stored value, else panics with the given message.
    /// # Examples
    /// ```
    /// use cnsl::error::RawPanics;
    /// use cnsl::stdin;
    ///
    /// let name = stdin::preadln("Enter your name: ").panics();
    /// ```
    fn panics(self) -> T;
}

/// This implementation provides a way of unwrapping a result, and panicking with
/// its error message if it contains an [Err] value.
impl<T, E> RawPanics<T, E> for Result<T, E>
where
    E: Display,
{
    /// Consumes `self`, then returns the stored value, else the error message.
    /// # Examples
    /// ```
    /// use cnsl::error::RawPanics;
    /// use cnsl::stdin;
    ///
    /// let name = stdin::preadln_raw(b"Enter your name").panics();
    /// ```
    fn panics(self) -> T {
        self.unwrap_or_else(|err| panic!("{}", err))
    }
}