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

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

use crate::{IntoResponse, Response};

/// Builds an unauthorized (HTTP 401) response.
///
/// Use this when the request lacks valid authentication credentials.
///
/// # Examples
///
/// ```rust
/// # struct User;
/// # async fn session(_cx: &Cx) -> Option<User> { None }
/// use topcoat::Result;
/// use topcoat::context::Cx;
/// use topcoat::router::unauthorized;
///
/// async fn current_user(cx: &Cx) -> Result<User> {
///     let Some(user) = session(cx).await else {
///         return Err(unauthorized().into());
///     };
///     Ok(user)
/// }
/// ```
#[must_use]
pub fn unauthorized() -> UnauthorizedError {
    UnauthorizedError::new()
}

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

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

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

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

impl IntoResponse for UnauthorizedError {
    fn into_response(self, cx: &Cx) -> Result<Response> {
        (StatusCode::UNAUTHORIZED, "unauthorized").into_response(cx)
    }
}