volga 0.9.1

Easy & Fast Web Framework for Rust
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

//! Macros for HTML responses

/// Produces `OK 200` response with HTML body
///
/// # Examples
/// ## Default usage
///```no_run
/// # use volga::HttpRequest;
/// use volga::html;
///
/// # async fn dox(request: HttpRequest) -> std::io::Result<()> {
/// html!(
///    r#"
///    <!doctype html>
///    <html>
///        <head>Hello!</head>
///        <body>
///            <p>Hello, World!</p>
///        </body>
///    </html>
///    "#);
/// # Ok(())
/// # }
#[macro_export]
macro_rules! html {
    ($body:expr) => {
        $crate::html!($body; [])
    };
    ($body:expr; [ $( $header:expr ),* $(,)? ]) => {
        $crate::response!(
            $crate::http::StatusCode::OK,
            $crate::HttpBody::full($body);
            [
                $crate::headers::ContentType::html_utf_8(),
                $( $header ),*
            ]
        )
    };
}

/// Produces `OK 200` response with HTML file body
///
/// # Examples
/// ## Default usage
///```no_run
/// # use volga::HttpRequest;
/// use volga::html_file;
/// use tokio::fs::File;
///
/// # async fn dox(request: HttpRequest) -> std::io::Result<()> {
/// let index_name = "index.html";
/// let index_file = File::open(index_name).await?;
/// html_file!(index_name, index_file);
/// # Ok(())
/// # }
#[macro_export]
macro_rules! html_file {
    ($file_name:expr, $body:expr) => {
        $crate::html_file!($file_name, $body; [])
    };
    ($file_name:expr, $body:expr; [ $( $header:expr ),* $(,)? ]) => {{
        let mime = $crate::fs::get_mime_or_octet_stream($file_name);
        $crate::response!(
            $crate::http::StatusCode::OK,
            $crate::HttpBody::file($body);
            [
                ($crate::headers::CONTENT_TYPE, mime.as_ref()),
                $( $header ),*
            ]
        )
    }};
}

/// Produces `NO CONTENT 204` response
///
/// # Examples
/// ## Default usage
///```no_run
/// # use volga::HttpRequest;
/// use volga::no_content;
///
/// # async fn dox(request: HttpRequest) -> std::io::Result<()> {
/// no_content!();
/// # Ok(())
/// # }
#[macro_export]
macro_rules! no_content {
    () => {
        $crate::response!(
            $crate::http::StatusCode::NO_CONTENT,
            $crate::HttpBody::empty()
        )
    };
}

#[cfg(test)]
mod tests {
    use crate::test::utils::read_file_bytes;
    use http_body_util::BodyExt;

    #[tokio::test]
    async fn it_creates_html_response() {
        let html_text = r#"
            <!doctype html>
            <html>
                <head>Hello!</head>
                <body>
                    <p>Hello, World!</p>
                </body>
            </html>
            "#;

        let response = html!(html_text);

        assert!(response.is_ok());

        let mut response = response.unwrap();
        let body = read_file_bytes(&mut response).await;

        assert_eq!(String::from_utf8_lossy(body.as_slice()), html_text);
        assert_eq!(response.status(), 200);
    }

    #[tokio::test]
    async fn it_creates_html_response_with_headers() {
        let html_text = r#"
            <!doctype html>
            <html>
                <head>Hello!</head>
                <body>
                    <p>Hello, World!</p>
                </body>
            </html>
            "#;

        let response = html!(html_text; [
            ("x-api-key", "some api key")
        ]);

        assert!(response.is_ok());

        let mut response = response.unwrap();
        let body = read_file_bytes(&mut response).await;

        assert_eq!(String::from_utf8_lossy(body.as_slice()), html_text);
        assert_eq!(response.headers()["x-api-key"], "some api key");
        assert_eq!(response.status(), 200);
    }

    #[tokio::test]
    async fn it_creates_no_content_response() {
        let response = no_content!();

        assert!(response.is_ok());

        let mut response = response.unwrap();
        let body = response.body_mut().collect().await.unwrap().to_bytes();

        assert_eq!(body.len(), 0);
        assert_eq!(response.status(), 204);
    }
}