aboutsummaryrefslogtreecommitdiff
path: root/src/primitive/bufferinfo.rs
blob: a87c418b6a888198d9978767fa2acbb28d363bfa (plain)
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
use std::vec::Vec;

use crate::{deserialize::*, error::ProtocolError, serialize::*};

/// The BufferInfo struct represents a BufferInfo as received in IRC
///
/// BufferInfo is, like all other struct based types, serialized sequentially.
#[derive(Clone, Debug, std::cmp::PartialEq)]
pub struct BufferInfo {
    /// a unique, sequential id for the buffer
    pub id: i32,
    /// NetworkId of the network the buffer belongs to
    pub network_id: i32,
    /// The Type of the Buffer
    pub buffer_type: BufferType,
    /// BufferName as displayed to the user
    pub name: String,
}

impl Serialize for BufferInfo {
    fn serialize(&self) -> Result<Vec<u8>, ProtocolError> {
        let mut values: Vec<u8> = Vec::new();

        values.append(&mut i32::serialize(&self.id)?);
        values.append(&mut i32::serialize(&self.network_id)?);
        values.append(&mut i16::serialize(&(self.buffer_type as i16))?);
        values.append(&mut vec![0, 0, 0, 0]);
        values.append(&mut String::serialize_utf8(&self.name)?);

        Ok(values)
    }
}

impl Deserialize for BufferInfo {
    fn parse(b: &[u8]) -> Result<(usize, Self), ProtocolError> {
        let (_, id) = i32::parse(&b[0..4])?;
        let (_, network_id) = i32::parse(&b[4..8])?;
        let (_, buffer_type) = i16::parse(&b[8..10])?;

        // There are 4 additional undocumented Bytes in the BufferInfo
        // so we start at byte 14
        // TODO is groupid
        let (size, name) = String::parse_utf8(&b[14..])?;

        return Ok((
            14 + size,
            Self {
                id,
                network_id,
                buffer_type: BufferType::from(buffer_type),
                name,
            },
        ));
    }
}

/// The Type of the Buffer
#[repr(i16)]
#[derive(Copy, Clone, Debug, std::cmp::PartialEq)]
pub enum BufferType {
    Status = 0x01,
    Channel = 0x02,
    Query = 0x04,
    Group = 0x08,
}

impl From<i16> for BufferType {
    fn from(value: i16) -> Self {
        match value {
            0x01 => return Self::Status,
            0x02 => return Self::Channel,
            0x04 => return Self::Query,
            0x08 => return Self::Group,
            _ => unimplemented!(),
        }
    }
}

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

    #[test]
    fn bufferinfo_serialize() {
        let buffer = BufferInfo {
            id: 1,
            network_id: 1,
            buffer_type: BufferType::Channel,
            name: "#test".to_string(),
        };

        assert_eq!(
            buffer.serialize().unwrap(),
            [0, 0, 0, 1, 0, 0, 0, 1, 0, 2, 0, 0, 0, 0, 0, 0, 0, 5, 35, 116, 101, 115, 116]
        )
    }

    #[test]
    fn bufferinfo_deserialize() {
        let buffer = BufferInfo {
            id: 1,
            network_id: 1,
            buffer_type: BufferType::Channel,
            name: "#test".to_string(),
        };
        let bytes = vec![
            0, 0, 0, 1, 0, 0, 0, 1, 0, 2, 0, 0, 0, 0, 0, 0, 0, 5, 35, 116, 101, 115, 116,
        ];

        assert_eq!(BufferInfo::parse(&bytes).unwrap(), (23, buffer))
    }
}