topcoat-router 0.3.1

A modular, batteries-included Rust web framework for server-rendered apps.
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

use http::StatusCode;
use topcoat_core::{context::Cx, error::Result};

use crate::{IntoResponse, Response};

/// Builds a forbidden (HTTP 403) response.
///
/// Use this when the caller is authenticated but not permitted to access
/// the resource.
///
/// # Examples
///
/// ```rust
/// # use topcoat::view::View;
/// # struct User;
/// # impl User { fn is_admin(&self) -> bool { true } }
/// # fn render_admin(_cx: &Cx) -> View { View::default() }
/// use topcoat::Result;
/// use topcoat::context::Cx;
/// use topcoat::router::forbidden;
///
/// async fn admin_panel(cx: &Cx, user: &User) -> Result<View> {
///     if !user.is_admin() {
///         return Err(forbidden().into());
///     }
///     Ok(render_admin(cx))
/// }
/// ```
#[must_use]
pub fn forbidden() -> ForbiddenError {
    ForbiddenError::new()
}

/// A forbidden response carried as the `Err` variant of a handler `Result`.
///
/// Construct one with [`forbidden`], or derive one from an `Option` /
/// `Result` via [`RouterErrorExt`](crate::RouterErrorExt).
#[derive(Debug)]
pub struct ForbiddenError {
    _priv: (),
}

impl ForbiddenError {
    fn new() -> Self {
        Self { _priv: () }
    }
}

impl std::fmt::Display for ForbiddenError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str("forbidden")
    }
}

impl std::error::Error for ForbiddenError {}

impl IntoResponse for ForbiddenError {
    fn into_response(self, cx: &Cx) -> Result<Response> {
        (StatusCode::FORBIDDEN, "forbidden").into_response(cx)
    }
}