ohkami 0.24.9

A performant, declarative, and runtime-flexible 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

#![cfg(feature = "ws")]

#[cfg(feature = "__rt_native__")]
mod native;
#[cfg(feature = "__rt_native__")]
pub use self::native::*;

#[cfg(feature = "rt_worker")]
mod worker;
#[cfg(feature = "rt_worker")]
pub use self::worker::*;

/// # Context for WebSocket handshake
///
/// `.upgrade(~)` performs handshake and creates a WebSocket session.
///
/// ### note
///
/// On native runtimes, the session is timeout in 3600 seconds ( = 1 hour )
/// by default. This is configurable by `OHKAMI_WEBSOCKET_TIMEOUT`
/// environment variable.
///
/// <br>
///
/// *example.rs*
/// ```
/// use ohkami::ws::{WebSocketContext, WebSocket};
///
/// async fn ws(ctx: WebSocketContext<'_>) -> WebSocket {
///     ctx.upgrade(|mut conn| async move {
///         conn.send("Hello, WebSocket! and bye...").await
///             .expect("failed to send")
///     })
/// }
/// ```
pub struct WebSocketContext<'req> {
    #[allow(unused/* on rt_worker */)]
    sec_websocket_key: &'req str,
}

impl<'req> crate::FromRequest<'req> for WebSocketContext<'req> {
    type Error = crate::Response;

    #[inline]
    fn from_request(req: &'req crate::Request) -> Option<Result<Self, Self::Error>> {
        #[cold]
        #[inline(never)]
        fn reject(message: &'static str) -> crate::Response {
            crate::Response::BadRequest().with_text(message)
        }

        if !matches!(req.headers.connection()?, "Upgrade" | "upgrade") {
            return Some(Err(reject(
                "upgrade request must have `Connection: Upgrade`",
            )));
        }
        if !(req.headers.upgrade()?.eq_ignore_ascii_case("websocket")) {
            return Some(Err(reject(
                "upgrade request must have `Upgrade: websocket`",
            )));
        }
        if req.headers.sec_websocket_version()? != "13" {
            return Some(Err(reject(
                "upgrade request must have `Sec-WebSocket-Version: 13`",
            )));
        }

        req.headers
            .sec_websocket_key()
            .map(|sec_websocket_key| Ok(Self { sec_websocket_key }))
    }
}

impl<'req> WebSocketContext<'req> {
    pub fn new(sec_websocket_key: &'req str) -> Self {
        Self { sec_websocket_key }
    }

    /*
        `.upgrade(~)` and something are implemented in
        `native` or `worker` submodule
    */
}