rusty_xkcd 0.1.2

quick_error! {
    /// The module containing all errors for rusty_xkcd
    #[derive(Debug)]
    pub enum Error {

        /// ### Invalid Number
        /// This error is thrown when the requested item's number is out of range
        ///
        /// #### Usage
        /// ```rust
        /// # use rusty_xkcd::Error;
        /// # fn get_number() -> i32 {
        /// #     10
        /// # }
        /// let number: i32 = get_number(); // Example function that returns an int
        /// match number {
        ///     1 => println!("The number is one!"),
        ///     _ => println!("{}", Error::Number(number)),
        /// }
        /// ```
        Number(number: i32) {
            description("Invalid xkcd num")
            display(r#"Invalid xkcd num: {}"#, number)
        }

        /// ### Request Error
        /// This error is thrown when a request fails
        ///
        /// #### Usage
        /// ```rust
        /// # use rusty_xkcd::Error;
        /// # fn make_request() -> Result<String, Error> {
        /// #     Ok(String::from("Successful Request!"))
        /// # }
        /// match make_request() {
        ///     // Example request function
        ///     Ok(data) => println!("{}", data),
        ///     Err(e) => println!("{}", Error::Request(e.to_string())),
        /// }
        /// ```
        Request(error: String) {
            description("Xkcd request Error")
            display(r#"Xkcd request error: {}"#, error)
        }
    }
}