poem 3.1.12

Poem is a full-featured and easy-to-use web framework with the Rust programming language.
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use std::fmt::Display;

use crate::{
    IntoResponse, Response,
    http::{StatusCode, header},
};

/// A redirect response.
///
/// # Example
///
/// ```
/// use poem::{
///     Endpoint, Request, Route, get, handler,
///     http::{HeaderValue, StatusCode, Uri, header},
///     test::TestClient,
///     web::Redirect,
/// };
///
/// #[handler]
/// async fn index() -> Redirect {
///     Redirect::moved_permanent("https://www.google.com")
/// }
///
/// let app = Route::new().at("/", get(index));
/// # tokio::runtime::Runtime::new().unwrap().block_on(async {
/// let resp = TestClient::new(app).get("/").send().await;
/// resp.assert_status(StatusCode::MOVED_PERMANENTLY);
/// resp.assert_header(header::LOCATION, "https://www.google.com");
/// # });
/// ```
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct Redirect {
    status: StatusCode,
    uri: String,
}

impl Redirect {
    /// A simple `308` permanent redirect to a different location.
    pub fn permanent(uri: impl Display) -> Self {
        Self {
            status: StatusCode::PERMANENT_REDIRECT,
            uri: uri.to_string(),
        }
    }

    /// A simple `301` permanent redirect to a different location.
    pub fn moved_permanent(uri: impl Display) -> Self {
        Self {
            status: StatusCode::MOVED_PERMANENTLY,
            uri: uri.to_string(),
        }
    }

    /// A simple `303` redirect to a different location.
    pub fn see_other(uri: impl Display) -> Self {
        Self {
            status: StatusCode::SEE_OTHER,
            uri: uri.to_string(),
        }
    }

    /// A simple `307` temporary redirect to a different location.
    pub fn temporary(uri: impl Display) -> Self {
        Self {
            status: StatusCode::TEMPORARY_REDIRECT,
            uri: uri.to_string(),
        }
    }
}

impl IntoResponse for Redirect {
    fn into_response(self) -> Response {
        self.status
            .with_header(header::LOCATION, self.uri)
            .into_response()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    macro_rules! test_redirect {
        ($fn:ident, $status:ident) => {
            #[test]
            fn $fn() {
                let resp = Redirect::$fn("https://example.com/").into_response();
                assert_eq!(resp.status(), StatusCode::$status);
                assert_eq!(
                    resp.headers()
                        .get(header::LOCATION)
                        .and_then(|value| value.to_str().ok()),
                    Some("https://example.com/")
                );
            }
        };
    }

    test_redirect!(permanent, PERMANENT_REDIRECT);
    test_redirect!(moved_permanent, MOVED_PERMANENTLY);
    test_redirect!(see_other, SEE_OTHER);
    test_redirect!(temporary, TEMPORARY_REDIRECT);
}