tunneler-core 0.3.4

Provides the Core functionality for the Tunneler software
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

use crate::message::{Data, MessageHeader};
use crate::objectpool::Guard;

#[cfg(test)]
use crate::message::MessageType;

/// A single Message that is send between the Server and Client
#[derive(Debug, PartialEq)]
pub struct Message {
    header: MessageHeader,
    data: Data<Vec<u8>>, // X bytes
}

impl Message {
    /// Creates a new Message with the given "raw" Data
    pub fn new(header: MessageHeader, data: Vec<u8>) -> Self {
        Self {
            header,
            data: Data::Raw(data),
        }
    }

    /// Creates a new Message with the given pooled/guarded Data
    pub fn new_guarded(header: MessageHeader, data: Guard<Vec<u8>>) -> Self {
        Self {
            header,
            data: Data::Pooled(data),
        }
    }

    /// Serializes the Message into a Vector of Bytes that can
    /// then be send over to the other side (Server or Client)
    pub fn serialize(&self) -> ([u8; 13], &[u8]) {
        let data = match self.data {
            Data::Raw(ref r) => r,
            Data::Pooled(ref p) => p,
        };

        (self.header.serialize(), data)
    }

    /// The Header of this message
    pub fn get_header(&self) -> &MessageHeader {
        &self.header
    }
    /// The Raw underlying data that belong to do this message
    pub fn get_data(&self) -> &[u8] {
        match self.data {
            Data::Raw(ref r) => &r,
            Data::Pooled(ref p) => &p,
        }
    }
}

#[test]
fn message_serialize_connect() {
    let mut inner_data = vec![0; 2];
    inner_data[0] = 1;
    inner_data[1] = 1;
    let msg = Message::new(
        MessageHeader {
            id: 13,
            kind: MessageType::Connect,
            length: 2,
        },
        inner_data,
    );

    let (h_output, d_output) = msg.serialize();

    let mut expected_header = [0; 13];
    expected_header[0] = 13;
    expected_header[5] = 2;
    assert_eq!(expected_header, h_output);

    let mut expected_data = vec![0; 2];
    expected_data[0] = 1;
    expected_data[1] = 1;
    assert_eq!(expected_data, d_output);
}
#[test]
fn message_serialize_data() {
    let mut inner_data = vec![0; 12];
    inner_data[2] = 33;
    let msg = Message::new(
        MessageHeader {
            id: 13,
            kind: MessageType::Data,
            length: 12,
        },
        inner_data,
    );
    let (h_output, d_output) = msg.serialize();

    let mut header_expect = [0; 13];
    header_expect[0] = 13;
    header_expect[4] = 2;
    header_expect[5] = 12;
    assert_eq!(header_expect, h_output);

    let mut data_expect = vec![0; 12];
    data_expect[2] = 33;
    assert_eq!(&data_expect, d_output);
}