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

use crate::{CloseFrame, Frame, OpCode, error::FragmentationError, fragments::FragmentsIterator};

/// A WebSocket message.
#[derive(Debug)]
pub enum Message<'a> {
    /// A text WebSocket message
    Text(&'a str),
    /// A binary WebSocket message
    Binary(&'a [u8]),
    /// A ping message with the specified payload
    ///
    /// The payload here must have a length less than 125 bytes
    Ping(&'a [u8]),
    /// A pong message with the specified payload
    ///
    /// The payload here must have a length less than 125 bytes
    Pong(&'a [u8]),
    /// A close message with the optional close frame.
    Close(Option<CloseFrame<'a>>),
}

impl<'a> Message<'a> {
    /// Indicates whether a message is a text message.
    pub const fn is_text(&self) -> bool {
        matches!(*self, Message::Text(_))
    }

    /// Indicates whether a message is a binary message.
    pub const fn is_binary(&self) -> bool {
        matches!(*self, Message::Binary(_))
    }

    /// Indicates whether a message is a ping message.
    pub const fn is_ping(&self) -> bool {
        matches!(*self, Message::Ping(_))
    }

    /// Indicates whether a message is a pong message.
    pub const fn is_pong(&self) -> bool {
        matches!(*self, Message::Pong(_))
    }

    /// Indicates whether a message is a close message.
    pub const fn is_close(&self) -> bool {
        matches!(*self, Message::Close(_))
    }

    pub(crate) const fn opcode(&self) -> OpCode {
        match self {
            Message::Text(_) => OpCode::Text,
            Message::Binary(_) => OpCode::Binary,
            Message::Ping(_) => OpCode::Ping,
            Message::Pong(_) => OpCode::Pong,
            Message::Close(_) => OpCode::Close,
        }
    }

    /// Get the length of the message's payload in bytes.
    pub(crate) const fn payload_len(&self) -> usize {
        match self {
            Message::Text(payload) => payload.len(),
            Message::Binary(payload) => payload.len(),
            Message::Ping(payload) => payload.len(),
            Message::Pong(payload) => payload.len(),
            Message::Close(Some(frame)) => 2 + frame.reason().len(),
            Message::Close(None) => 0,
        }
    }

    pub(crate) fn write(&self, dst: &mut [u8]) -> Option<usize> {
        if dst.len() < self.payload_len() {
            return None;
        }

        match self {
            Message::Text(payload) => {
                dst[..payload.len()].copy_from_slice(payload.as_bytes());
            }
            Message::Binary(payload) => {
                dst[..payload.len()].copy_from_slice(payload);
            }
            Message::Ping(payload) => {
                dst[..payload.len()].copy_from_slice(payload);
            }
            Message::Pong(payload) => {
                dst[..payload.len()].copy_from_slice(payload);
            }
            Message::Close(Some(frame)) => {
                let code: u16 = frame.code().into_u16();
                let code = code.to_be_bytes();

                dst[0..2].copy_from_slice(&code);
                dst[2..2 + frame.reason().len()].copy_from_slice(frame.reason().as_bytes());
            }
            Message::Close(None) => {}
        }

        Some(self.payload_len())
    }

    /// See [`FragmentsIterator::new()`] for details on how to create the iterator.
    pub(crate) fn fragments(
        &self,
        fragment_size: usize,
    ) -> Result<impl Iterator<Item = Frame<'a>>, FragmentationError> {
        if fragment_size < 1 {
            return Err(FragmentationError::InvalidFragmentSize);
        }

        match self {
            Message::Text(payload) => Ok(FragmentsIterator::new(
                OpCode::Text,
                payload.as_bytes(),
                fragment_size,
            )),
            Message::Binary(payload) => Ok(FragmentsIterator::new(
                OpCode::Binary,
                payload,
                fragment_size,
            )),
            _ => Err(FragmentationError::CanNotBeFragmented),
        }
    }
}