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

//! Macros for SSE (Server Sent Events) responses

/// Produces `OK 200` response with SSE (Server-Sent Events) stream body
#[macro_export]
#[cfg(feature = "http2")]
macro_rules! sse {
    ($body:expr) => {
        $crate::sse!(
            $body;
            []
        )
    };
    ($body:expr; [ $( $header:expr ),* $(,)? ]) => {
        $crate::response!(
            $crate::http::StatusCode::OK,
            $crate::HttpBody::stream($body);
            [
                $crate::headers::ContentType::events(),
                $crate::headers::CacheControl::no_cache(),
                ($crate::headers::X_ACCEL_BUFFERING, "no"),
                $( $header ),*
            ]
        )
    };
}

/// Produces `OK 200` response with SSE (Server-Sent Events) stream body
#[macro_export]
#[cfg(all(not(feature = "http2"), feature = "http1"))]
macro_rules! sse {
    ($body:expr) => {
        $crate::sse!(
            $body;
            []
        )
    };
    ($body:expr; [ $( $header:expr ),* $(,)? ]) => {
        $crate::response!(
            $crate::http::StatusCode::OK,
            $crate::HttpBody::stream($body);
            [
                $crate::headers::ContentType::events(),
                $crate::headers::CacheControl::no_cache(),
                ($crate::headers::CONNECTION, "keep-alive"),
                ($crate::headers::X_ACCEL_BUFFERING, "no"),
                $( $header ),*
            ]
        )
    };
}

#[cfg(test)]
mod tests {
    use crate::error::Error;
    use crate::headers::{CACHE_CONTROL, CONTENT_TYPE, X_ACCEL_BUFFERING};
    use crate::http::sse::Message;
    use futures_util::stream::{StreamExt, repeat_with};
    use http_body_util::BodyExt;

    #[cfg(all(not(feature = "http2"), feature = "http1"))]
    use crate::headers::CONNECTION;

    #[tokio::test]
    async fn it_creates_sse_response() {
        let stream = Message::new().data("hi!").repeat().take(1);

        let mut response = sse!(stream).unwrap();
        let body = &response.body_mut().collect().await.unwrap().to_bytes();

        assert_eq!(response.status(), 200);
        assert_eq!(String::from_utf8_lossy(body), "data: hi!\n\n");
        assert_eq!(
            response.headers().get(&CONTENT_TYPE).unwrap(),
            "text/event-stream"
        );
        assert_eq!(response.headers().get(&CACHE_CONTROL).unwrap(), "no-cache");
        #[cfg(all(not(feature = "http2"), feature = "http1"))]
        assert_eq!(response.headers().get(&CONNECTION).unwrap(), "keep-alive");
        assert_eq!(response.headers().get(&X_ACCEL_BUFFERING).unwrap(), "no");
    }

    #[tokio::test]
    async fn it_creates_sse_response_with_headers() {
        let stream = repeat_with(|| Ok::<_, Error>("data: hi!\n\n")).take(1);

        let mut response = sse!(stream; [
            ("x-header", "some value"),
        ])
        .unwrap();
        let body = &response.body_mut().collect().await.unwrap().to_bytes();

        assert_eq!(response.status(), 200);
        assert_eq!(String::from_utf8_lossy(body), "data: hi!\n\n");
        assert_eq!(
            response.headers().get(&CONTENT_TYPE).unwrap(),
            "text/event-stream"
        );
        assert_eq!(response.headers().get(&CACHE_CONTROL).unwrap(), "no-cache");
        #[cfg(all(not(feature = "http2"), feature = "http1"))]
        assert_eq!(response.headers().get(&CONNECTION).unwrap(), "keep-alive");
        assert_eq!(response.headers().get(&X_ACCEL_BUFFERING).unwrap(), "no");
        assert_eq!(response.headers().get("x-header").unwrap(), "some value");
    }
}