Struct Error

Source

pub struct Error { /* private fields */ }

Expand description

A handler error: a status, a stable code, and an optional source kept for the logs. The visitor sees the status, a generic message, and the request’s reference; never the code or the source.

use web_net::Error;

let e = Error::not_found("blog.no_post");
assert_eq!((e.status(), e.code()), (404, "blog.no_post"));

let io = std::io::Error::other("disk gone");
let e = Error::internal("blog.read").with_source(io);
assert_eq!(e.status(), 500);
assert!(e.source_ref().is_some());

Implementations§

Source §

impl Error

Source

pub fn new(status: u16, code: &'static str) -> Self

An error with status (400 to 599; anything else is treated as 500).

use web_net::Error;

assert_eq!(Error::new(429, "rate.limited").status(), 429);
// A status outside 400 to 599 is treated as 500.
assert_eq!(Error::new(200, "not.an.error").status(), 500);

Source

pub fn bad_request(code: &'static str) -> Self

400 Bad Request.

let e = web_net::Error::bad_request("search.no_query");
assert_eq!((e.status(), e.code()), (400, "search.no_query"));

Source

pub fn forbidden(code: &'static str) -> Self

403 Forbidden.

use web_net::{App, Error, get};

let app = App::builder()
    .route(get("/admin", |_cx| Err(Error::forbidden("admin.closed"))))
    .build()?;
let r = serve_net::testing::respond(&app, b"GET /admin HTTP/1.1\r\nHost: localhost\r\n\r\n");
assert_eq!(r.status, 403);

Source

pub fn not_found(code: &'static str) -> Self

404 Not Found.

let e = web_net::Error::not_found("blog.no_post");
assert_eq!((e.status(), e.code()), (404, "blog.no_post"));

Source

pub fn conflict(code: &'static str) -> Self

409 Conflict.

let e = web_net::Error::conflict("user.name_taken");
assert_eq!((e.status(), e.code()), (409, "user.name_taken"));

Source

pub fn unprocessable(code: &'static str) -> Self

422 Unprocessable Content: the request was understood and refused (a form with errors).

let e = web_net::Error::unprocessable("signup.weak_password");
assert_eq!((e.status(), e.code()), (422, "signup.weak_password"));

Source

pub fn internal(code: &'static str) -> Self

500 Internal Server Error: our fault, not the visitor’s.

let e = web_net::Error::internal("report.parse");
assert_eq!((e.status(), e.code()), (500, "report.parse"));

Source

pub fn unavailable(code: &'static str) -> Self

503 Service Unavailable.

let e = web_net::Error::unavailable("db.down");
assert_eq!((e.status(), e.code()), (503, "db.down"));

Source

pub fn with_source( self, source: impl Into<Box<dyn Error + Send + Sync>>, ) -> Self

Keeps source for the logs.

use web_net::Error;

let io = std::io::Error::other("no such file");
let e = Error::internal("config.read").with_source(io);
assert_eq!(e.source_ref().map(|s| s.to_string()), Some("no such file".to_owned()));

Source

pub const fn status(&self) -> u16

The status.

assert_eq!(web_net::Error::conflict("cart.changed").status(), 409);

Source

pub const fn code(&self) -> &'static str

The code.

assert_eq!(web_net::Error::not_found("blog.no_post").code(), "blog.no_post");

Source

pub fn source_ref(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

The source, if one was kept.

use web_net::Error;

assert!(Error::internal("x").source_ref().is_none());
let e = Error::internal("x").with_source(std::io::Error::other("disk gone"));
assert!(e.source_ref().is_some());