microsandbox-protocol 0.5.7

Wire protocol types and serialization for the microsandbox project.
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
76
77
78
79
80
81
82
83
84
85
86

//! TCP stream protocol message payloads.

use serde::{Deserialize, Serialize};

//--------------------------------------------------------------------------------------------------
// Types
//--------------------------------------------------------------------------------------------------

/// Request to open a TCP connection from inside the guest.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TcpConnect {
    /// Destination host name or address as seen by the guest.
    pub host: String,

    /// Destination TCP port.
    pub port: u16,
}

/// Confirmation that a TCP connection was opened.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TcpConnected {}

/// TCP stream data.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TcpData {
    /// The raw stream bytes.
    #[serde(with = "serde_bytes")]
    pub data: Vec<u8>,
}

/// Notification that one side has closed its write half.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TcpEof {}

/// Request to close the TCP session.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TcpClose {}

/// Terminal notification that the TCP session is closed.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TcpClosed {}

/// Terminal notification that the TCP session failed.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TcpFailed {
    /// Human-readable failure description.
    pub error: String,
}

//--------------------------------------------------------------------------------------------------
// Tests
//--------------------------------------------------------------------------------------------------

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

    #[test]
    fn tcp_payloads_roundtrip() {
        let connect = TcpConnect {
            host: "127.0.0.1".to_string(),
            port: 8080,
        };
        let mut buf = Vec::new();
        ciborium::into_writer(&connect, &mut buf).unwrap();
        let decoded: TcpConnect = ciborium::from_reader(&buf[..]).unwrap();
        assert_eq!(decoded.host, connect.host);
        assert_eq!(decoded.port, connect.port);

        let data = TcpData {
            data: b"hello".to_vec(),
        };
        buf.clear();
        ciborium::into_writer(&data, &mut buf).unwrap();
        let decoded: TcpData = ciborium::from_reader(&buf[..]).unwrap();
        assert_eq!(decoded.data, data.data);

        let failed = TcpFailed {
            error: "connection refused".to_string(),
        };
        buf.clear();
        ciborium::into_writer(&failed, &mut buf).unwrap();
        let decoded: TcpFailed = ciborium::from_reader(&buf[..]).unwrap();
        assert_eq!(decoded.error, failed.error);
    }
}