gproxy-protocol 4.1.14

GPROXY v4 connection modelling, operation declarations, vendor wire types and pairwise conversion
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

use std::{fmt, pin::Pin};

use futures_core::Stream;
use futures_sink::Sink;

use super::{Bytes, TransportError};

/// A complete WebSocket data message or control frame. The transport adapter
/// handles wire fragmentation, masking, and protocol validation.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum WsFrame {
    Text(String),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    Close(Option<WsClose>),
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct WsClose {
    pub code: u16,
    pub reason: String,
}

#[cfg(not(target_arch = "wasm32"))]
pub type WsReceiver = Pin<Box<dyn Stream<Item = Result<WsFrame, TransportError>> + Send + 'static>>;

#[cfg(target_arch = "wasm32")]
pub type WsReceiver = Pin<Box<dyn Stream<Item = Result<WsFrame, TransportError>> + 'static>>;

#[cfg(not(target_arch = "wasm32"))]
pub type WsSender = Pin<Box<dyn Sink<WsFrame, Error = TransportError> + Send + 'static>>;

#[cfg(target_arch = "wasm32")]
pub type WsSender = Pin<Box<dyn Sink<WsFrame, Error = TransportError> + 'static>>;

/// An established connection. Sending and receiving are independent; there is
/// no request/response pairing. The HTTP handshake is represented separately
/// by [`super::WireRequest`] and [`super::WireResponse`].
pub struct WebSocket {
    pub incoming: WsReceiver,
    pub outgoing: WsSender,
}

impl fmt::Debug for WebSocket {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("WebSocket { incoming: .., outgoing: .. }")
    }
}