supertunnel 0.1.0

Build stateful proxy tunnels that resist network disruptions.
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

use bytes::Bytes;

/// A discrete frame of data.
///
/// Includes the core payload and padding to obscure traffic patterns.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct FramingMessage {
    pub data: Bytes,
    pub padding: Bytes,
}

impl FramingMessage {
    /// Creates a new [`FramingMessage`].
    ///
    /// # Inputs
    ///
    /// * `data: Bytes` - The primary data payload.
    /// * `padding: Bytes` - The padding bytes to obscure the true message length.
    pub fn new(data: Bytes, padding: Bytes) -> Self {
        Self { data, padding }
    }

    /// Creates a new [`FramingMessage`] with a zero-length padding field.
    ///
    /// # Inputs
    ///
    /// * `data: Bytes` - The primary data payload.
    pub fn new_data(data: Bytes) -> Self {
        Self::new(data, Bytes::new())
    }

    /// Creates a new [`FramingMessage`] with a zero-length data field.
    ///
    /// # Inputs
    ///
    /// * `padding: Bytes` - The padding bytes to obscure the true message length.
    pub fn new_padding(padding: Bytes) -> Self {
        Self::new(Bytes::new(), padding)
    }
}