websocketz 0.2.0

A zerocopy websockets implementation for no_std environments.
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

//! Options for establishing and accepting WebSocket connections.

use crate::http::Header;

/// Errors that can occur when creating [`ConnectOptions`].
#[derive(Debug, thiserror::Error)]
pub enum ConnectOptionsError {
    /// The path must not be empty.
    #[error("path must not be empty")]
    EmptyPath,
}

/// Options for establishing a WebSocket connection as a client.
#[derive(Debug)]
#[non_exhaustive]
pub struct ConnectOptions<'a, 'b> {
    /// The request path for the WebSocket handshake.
    ///
    /// Must not be empty.
    pub(crate) path: &'a str,
    /// Additional HTTP headers to include in the handshake request.
    pub headers: &'a [Header<'b>],
}

impl<'a, 'b> Default for ConnectOptions<'a, 'b> {
    fn default() -> Self {
        Self::default()
    }
}

impl<'a, 'b> ConnectOptions<'a, 'b> {
    /// Creates a new [`ConnectOptions`] with the given path, returning an error if the path is empty.
    pub fn new(path: &'a str) -> Result<Self, ConnectOptionsError> {
        Self::default().with_path(path)
    }

    /// Creates a new [`ConnectOptions`] with the given path without checking if the path is empty.
    pub const fn new_unchecked(path: &'a str) -> Self {
        Self::default().with_path_unchecked(path)
    }

    /// Returns the path
    pub const fn path(&self) -> &str {
        self.path
    }

    /// Sets the path, returning an error if the path is empty.
    pub fn with_path(mut self, path: &'a str) -> Result<Self, ConnectOptionsError> {
        if path.trim().is_empty() {
            return Err(ConnectOptionsError::EmptyPath);
        };

        self.path = path.trim();
        Ok(self)
    }

    /// Sets the path without checking if it is empty.
    pub const fn with_path_unchecked(mut self, path: &'a str) -> Self {
        self.path = path;
        self
    }

    /// Returns the headers
    pub const fn headers(&self) -> &[Header<'b>] {
        self.headers
    }

    /// Sets the headers.
    pub const fn with_headers(mut self, headers: &'a [Header<'b>]) -> Self {
        self.headers = headers;
        self
    }

    /// Creates a new [`ConnectOptions`] with default values.
    ///
    /// This is an internal `const` function alternative to [`Default::default()`].
    const fn default() -> Self {
        Self {
            path: "/",
            headers: &[],
        }
    }
}

/// Options for accepting a WebSocket connection as a server.
#[derive(Debug, Default)]
#[non_exhaustive]
pub struct AcceptOptions<'a, 'b> {
    /// Additional HTTP headers to include in the handshake response.
    pub headers: &'a [Header<'b>],
}

impl<'a, 'b> AcceptOptions<'a, 'b> {
    /// Sets the headers.
    pub const fn with_headers(mut self, headers: &'a [Header<'b>]) -> Self {
        self.headers = headers;
        self
    }

    /// Returns the headers.
    pub const fn headers(&self) -> &[Header<'b>] {
        self.headers
    }
}

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

    #[test]
    fn empty_path() {
        let error = ConnectOptions::new("").unwrap_err();
        assert!(matches!(error, ConnectOptionsError::EmptyPath));

        let error = ConnectOptions::new("    ").unwrap_err();
        assert!(matches!(error, ConnectOptionsError::EmptyPath));
    }

    #[test]
    fn path_is_trimmed() {
        let options = ConnectOptions::new("  /test  ").unwrap();
        assert_eq!(options.path(), "/test");

        let options = ConnectOptions::new("/test").unwrap();
        assert_eq!(options.path(), "/test");
    }
}