openwire-core 0.1.1

Shared primitives, policies, bodies, and transport traits for OpenWire
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

use std::pin::Pin;
use std::sync::Arc;

use bytes::Bytes;
use futures_core::Stream;
use futures_util::sink::Sink;

use super::error::WebSocketEngineError;
use crate::transport::BoxConnection;
use crate::BoxFuture;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Role {
    Client,
    /// Reserved for v2; engines may reject `Server` with
    /// [`WebSocketEngineError::UnsupportedExtension`].
    Server,
}

#[derive(Clone, Debug)]
pub struct WebSocketEngineConfig {
    pub role: Role,
    pub subprotocol: Option<String>,
    pub extensions: Vec<String>,
    pub max_frame_size: usize,
    pub max_message_size: usize,
}

#[derive(Clone, Debug)]
pub enum EngineFrame {
    Text(String),
    Binary(Bytes),
    Ping(Bytes),
    Pong(Bytes),
    /// Close frame. `code == 1005` with an empty reason is the internal
    /// "no status code received" sentinel and must be encoded as an empty
    /// close payload, never as a two-byte wire close code.
    Close {
        code: u16,
        reason: String,
    },
}

pub type BoxEngineSink = Pin<Box<dyn Sink<EngineFrame, Error = WebSocketEngineError> + Send>>;
pub type BoxEngineStream =
    Pin<Box<dyn Stream<Item = Result<EngineFrame, WebSocketEngineError>> + Send>>;

pub struct WebSocketChannel {
    pub send: BoxEngineSink,
    pub recv: BoxEngineStream,
}

pub trait WebSocketEngine: Send + Sync + 'static {
    fn upgrade(
        &self,
        io: BoxConnection,
        config: WebSocketEngineConfig,
    ) -> BoxFuture<Result<WebSocketChannel, WebSocketEngineError>>;
}

pub type SharedWebSocketEngine = Arc<dyn WebSocketEngine>;