hyprwire 0.2.9

A fast and consistent wire protocol for IPC
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use crate::implementation::types;
use crate::message;

#[derive(Debug)]
pub struct RoundtripRequest {
    seq: u32,
    data: [u8; 7],
}

impl RoundtripRequest {
    pub fn new(seq: u32) -> Self {
        let mut data = [0u8; 7];

        data[0] = message::MessageType::RoundtripRequest as u8;
        data[1] = types::MessageMagic::TypeUint as u8;
        data[2..2 + 4].copy_from_slice(&seq.to_le_bytes());
        data[6] = types::MessageMagic::End as u8;

        Self { seq, data }
    }

    pub fn seq(&self) -> u32 {
        self.seq
    }

    pub fn from_bytes(data: &[u8], offset: usize) -> super::Result<Self> {
        if *data.get(offset).ok_or(message::Error::UnexpectedEof)?
            != message::MessageType::RoundtripRequest as u8
        {
            return Err(message::Error::InvalidMessageType);
        }

        if *data.get(offset + 1).ok_or(message::Error::UnexpectedEof)?
            != types::MessageMagic::TypeUint as u8
        {
            return Err(message::Error::InvalidFieldType);
        }

        let bytes: [u8; 4] = data
            .get(offset + 2..offset + 2 + size_of::<u32>())
            .ok_or(message::Error::UnexpectedEof)?
            .try_into()
            .unwrap();
        let seq = u32::from_le_bytes(bytes);

        if *data.get(offset + 6).ok_or(message::Error::UnexpectedEof)?
            != types::MessageMagic::End as u8
        {
            return Err(message::Error::MalformedMessage);
        }

        Ok(Self {
            seq,
            data: data[offset..offset + 7].try_into().unwrap(),
        })
    }
}

impl message::Message for RoundtripRequest {
    fn data(&self) -> &[u8] {
        &self.data
    }

    fn message_type(&self) -> message::MessageType {
        message::MessageType::RoundtripRequest
    }
}

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

    #[test]
    fn roundtrip_request_new() {
        let msg = RoundtripRequest::new(2);
        let parsed = msg.parse_data();
        assert_eq!(parsed, "RoundtripRequest ( 2 ) ");
    }

    #[test]
    fn roundtrip_request_from_bytes() {
        let bytes: &[u8] = &[
            message::MessageType::RoundtripRequest as u8,
            types::MessageMagic::TypeUint as u8,
            0x2A,
            0x00,
            0x00,
            0x00,
            types::MessageMagic::End as u8,
        ];
        let msg = RoundtripRequest::from_bytes(bytes, 0).unwrap();
        let parsed = msg.parse_data();
        assert_eq!(parsed, "RoundtripRequest ( 42 ) ");
    }

    #[test]
    fn roundtrip_request_from_bytes_unexpected_eof() {
        let bytes: &[u8] = &[
            message::MessageType::RoundtripRequest as u8,
            types::MessageMagic::TypeUint as u8,
        ];
        let err = RoundtripRequest::from_bytes(bytes, 0).unwrap_err();
        assert!(matches!(err, message::Error::UnexpectedEof));
    }

    #[test]
    fn roundtrip_request_from_bytes_malformed() {
        let bytes: &[u8] = &[
            message::MessageType::RoundtripRequest as u8,
            types::MessageMagic::TypeUint as u8,
            0x2A,
            0x00,
            0x00,
            0x00,
            types::MessageMagic::TypeUint as u8,
        ];
        let err = RoundtripRequest::from_bytes(bytes, 0).unwrap_err();
        assert!(matches!(err, message::Error::MalformedMessage));
    }

    #[test]
    fn roundtrip_request_roundtrip_parses_seq() {
        let out = RoundtripRequest::new(777);
        let in_msg = RoundtripRequest::from_bytes(out.data(), 0).unwrap();
        assert_eq!(in_msg.data(), out.data());
        assert_eq!(in_msg.seq(), 777);
    }

    #[test]
    fn roundtrip_request_rejects_wrong_field_type() {
        // varchar instead of uint
        let bytes: &[u8] = &[
            message::MessageType::RoundtripRequest as u8,
            types::MessageMagic::TypeVarchar as u8,
            0x01,
            b'x',
            types::MessageMagic::End as u8,
        ];
        let err = RoundtripRequest::from_bytes(bytes, 0).unwrap_err();
        assert!(matches!(err, message::Error::InvalidFieldType));
    }
}