wsio-core 0.12.5

Shared core library for ws.io — provides common types, traits, and abstractions for WebSocket-based communication.
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

use tungstenite::protocol::WebSocketConfig;

pub mod event;
pub mod packet;
pub mod traits;
pub mod types;
pub mod utils;

pub fn channel_capacity_from_websocket_config(websocket_config: &WebSocketConfig) -> usize {
    let ratio = (websocket_config.max_write_buffer_size as f64 / websocket_config.write_buffer_size as f64).max(1.0);
    let capacity = (ratio.log2() * 256.0).round() as usize;
    capacity.clamp(64, 16384)
}

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

    #[test]
    fn test_channel_capacity_from_websocket_config() {
        let mut config = WebSocketConfig::default();

        // Scenario 1: High ratio
        config.write_buffer_size = 1024;
        config.max_write_buffer_size = 1024 * 16; // ratio 16
        let capacity = channel_capacity_from_websocket_config(&config);
        assert_eq!(capacity, 1024); // log2(16) * 256 = 4 * 256 = 1024

        // Scenario 2: Ratio < 1 (fallback max)
        config.write_buffer_size = 1024;
        config.max_write_buffer_size = 512;
        let capacity = channel_capacity_from_websocket_config(&config);
        assert_eq!(capacity, 64); // log2(1) * 256 = 0 -> clamped to 64

        // Scenario 3: Very high ratio (but within clamp)
        config.write_buffer_size = 1024;
        config.max_write_buffer_size = 1024 * 1024 * 1024; // ratio 2^20
        let capacity = channel_capacity_from_websocket_config(&config);
        assert_eq!(capacity, 5120); // log2(2^20) * 256 = 20 * 256 = 5120

        // Scenario 4: Absolute maximum clamp
        config.write_buffer_size = 1;
        config.max_write_buffer_size = 1024 * 1024 * 1024 * 1024; // ratio 2^40
        let capacity = channel_capacity_from_websocket_config(&config);
        assert_eq!(capacity, 10240); // 40 * 256 = 10240, still below 16384
    }
}