18 releases

0.3.0 Feb 23, 2023
0.2.3 Jan 14, 2021
0.2.2 Aug 16, 2020
0.2.1 Jul 3, 2019
0.1.1 Mar 24, 2016

#348 in Rust patterns

Download history 5230/week @ 2023-11-18 5940/week @ 2023-11-25 5544/week @ 2023-12-02 6511/week @ 2023-12-09 5649/week @ 2023-12-16 3039/week @ 2023-12-23 4770/week @ 2023-12-30 6721/week @ 2024-01-06 7371/week @ 2024-01-13 6977/week @ 2024-01-20 16636/week @ 2024-01-27 7401/week @ 2024-02-03 7642/week @ 2024-02-10 10063/week @ 2024-02-17 10071/week @ 2024-02-24 11745/week @ 2024-03-02

40,782 downloads per month
Used in 116 crates (86 directly)

MIT/Apache

20KB
220 lines

simple-error

Documentation Build Status Coverage Status MSRV

simple-error is a Rust library that provides a simple Error type backed by a String. It is best used when all you care about the error is an error string.

Documentation

Usage

To use simple-error, first add this to your Cargo.toml:

[dependencies]
simple-error = "0.2"

Then add this to your crate root:

#[macro_use]
extern crate simple_error;

use simple_error::SimpleError;

Or you can skip the extern crate and just import relevant items you use if you are on 2018 edition or beyond.

Now you can use simple-error in different ways:

You can use it simply as a string error type:

fn do_foo() -> Result<(), SimpleError> {
    Err(SimpleError::new("cannot do foo"))
}

You can use it to replace all error types if you only care about a string description:

fn do_bar() -> Result<(), SimpleError> {
    Err(SimpleError::from(std::io::Error(io::ErrorKind::Other, "oh no")))
}

Or you can chain all the errors, and get a complete error description at the top level:

fn find_tv_remote() -> Result<(), SimpleError> {
    try_with!(std::fs::File::open("remotefile"), "failed to open remote file");
    Ok(())
}

fn turn_on_tv() -> Result<(), std::io::Error> {
    Ok(())
}

fn watch_tv() -> Result<(), SimpleError> {
    try_with!(find_tv_remote(), "tv remote not found");
    try_with!(turn_on_tv(), "cannot turn on tv");
    Ok(())
}

fn study() -> Result<(), SimpleError> {
    Ok(())
}

fn run() -> Result<(), SimpleError> {
    try_with!(study(), "cannot study");
    try_with!(watch_tv(), "cannot watch tv");
    Ok(())
}

fn main() {
    if let Err(e) = run() {
        println!("{}", e);
    }
}
// This prints out "cannot watch tv, tv remote not found, failed to open remote file, Text file busy" if the error is text file busy.

No runtime deps