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

/// Read a [`Message`](crate::Message) from a [`WebSocket`](crate::WebSocket) or [`WebSocketRead`](crate::WebSocketRead).
///
/// # Parameters
///
/// - `$websocketz`: The WebSocket instance to read from.
///
/// # Return
/// - `Some(Ok(Message))`: A message was successfully read.
/// - `Some(Err(Error))`: An error occurred while reading a message. The caller should stop reading.
/// - `None`: The WebSocket connection has been closed (EOF). The caller should stop reading.
#[macro_export]
macro_rules! next {
    ($websocketz:expr) => {{
        'next: loop {
            match $websocketz
                .caller()
                .call(
                    $websocketz.auto(),
                    &mut $websocketz.core.framed.core.codec,
                    &mut $websocketz.core.framed.core.inner,
                    &mut $websocketz.core.framed.core.state.read,
                    &mut $websocketz.core.framed.core.state.write,
                    &mut $websocketz.core.fragments_state,
                    &mut $websocketz.core.state,
                )
                .await
            {
                Some(Ok(None)) => continue 'next,
                Some(Ok(Some(item))) => break 'next Some(Ok(item)),
                Some(Err(err)) => break 'next Some(Err(err)),
                None => break 'next None,
            }
        }
    }};
}

/// Send a [`Message`](crate::Message) through a [`WebSocket`](crate::WebSocket) or [`WebSocketWrite`](crate::WebSocketWrite).
///
/// # Parameters
/// - `$websocketz`: The WebSocket instance to send the message through.
/// - `$message`: The message to send.
#[macro_export]
macro_rules! send {
    ($websocketz:expr, $message:expr) => {{
        $crate::functions::send(
            &mut $websocketz.core.framed.core.codec,
            &mut $websocketz.core.framed.core.inner,
            &mut $websocketz.core.framed.core.state.write,
            &mut $websocketz.core.state,
            $message,
        )
        .await
    }};
}

/// Send a fragmented [`Message`](crate::Message) through a [`WebSocket`](crate::WebSocket) or [`WebSocketWrite`](crate::WebSocketWrite).
///
/// # Parameters
/// - `$websocketz`: The WebSocket instance to send the message through.
/// - `$message`: The message to send.
/// - `$fragment_size`: The size of each fragment.
#[macro_export]
macro_rules! send_fragmented {
    ($websocketz:expr, $message:expr, $fragment_size:expr) => {{
        $crate::functions::send_fragmented(
            &mut $websocketz.core.framed.core.codec,
            &mut $websocketz.core.framed.core.inner,
            &mut $websocketz.core.framed.core.state.write,
            &mut $websocketz.core.state,
            $message,
            $fragment_size,
        )
        .await
    }};
}