#rocket #failure #error #api

rocket_failure_errors

Error structs for rocket_failure

1 unstable release

0.2.0 Jul 22, 2019

#16 in #errors

Download history 57/week @ 2024-07-20 61/week @ 2024-07-27 58/week @ 2024-08-03 41/week @ 2024-08-10 47/week @ 2024-08-17 30/week @ 2024-08-24 57/week @ 2024-08-31 59/week @ 2024-09-07 111/week @ 2024-09-14 84/week @ 2024-09-21 65/week @ 2024-09-28 33/week @ 2024-10-05 35/week @ 2024-10-12 25/week @ 2024-10-19 25/week @ 2024-10-26 34/week @ 2024-11-02

122 downloads per month
Used in 3 crates (2 directly)

MIT/Apache

3KB

rocket_failure

Semantic error handling for rocket applications.

To enable this crate in your server add this line to your Cargo.toml:

rocket_failure = { version="0.1", features = ["with-rocket"] }
#![feature(proc_macro_hygiene, decl_macro)]

#[macro_use] extern crate rocket;
#[macro_use] extern crate rocket_failure;

use rocket_failure::errors::*;
use std::fs;

#[get("/<file>")]
fn index(file: String) -> ApiResult<Vec<u8>> {
    if !file.chars().all(|c| char::is_alphanumeric(c) || c == '-' || c == '.') {
        bad_request!("file contains forbidden characters")
    }

    // if this returns an Err(_), return a standard 404
    let content = fs::read(&file)
        .not_found()?;

    // detailed errors are hidden by default
    // we can publish the actual error if we want to
    /*
    let content = fs::read(&file)
        .not_found()
        .publish_error()?;
    */

    // or we can set a public error while preserving the actual error
    /*
    let content = fs::read(&file)
        .not_found()
        .public_context("That didn't work")?;
    */

    Ok(content)
}

fn main() {
    rocket::ignite().mount("/", routes![index]).launch();
}

You can run this example with:

cargo +nightly run --example fileserver --features=with-rocket

With you want to use the ApiResult<T> type in your api client to consume the api, omit the with-rocket feature:

rocket_failure = "0.1"

License

rocket_failure is licensed under either of the following, at your option:

Dependencies

~0.4–1MB
~22K SLoC