tox_packet 0.1.1

Encoding/decoding for the tox protocol
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

/*! FileControl struct.
It is used to control transferring file to a friend.
*/

use super::*;
use nom::number::complete::le_u8;

/** FileControl is a struct that holds info to handle transferring file to a friend.

This packet is used to control transferring sender's file to a friend.
If a peer of connection wants to pause, kill, seek or accept transferring file, it would use this packet.

Serialized form:

Length    | Content
--------- | ------
`1`       | `0x51`
`1`       | Whether it is sending or receiving, 0 = sender, 1 = receiver
`1`       | `file_id`
`1`       | Control type: 0 = accept, 1 = pause, 2 = kill, 3 = seek
`8`       | Seek parameter which is only included when `control type` is seek(3)

*/

#[derive(Clone, Debug, Eq, PartialEq)]
pub struct FileControl {
    transfer_direction: TransferDirection,
    file_id: u8,
    control_type: ControlType,
}

impl FromBytes for FileControl {
    named!(from_bytes<FileControl>, do_parse!(
        tag!("\x51") >>
        transfer_direction: call!(TransferDirection::from_bytes) >>
        file_id: le_u8 >>
        control_type: call!(ControlType::from_bytes) >>
        (FileControl {
            transfer_direction,
            file_id,
            control_type,
        })
    ));
}

impl ToBytes for FileControl {
    fn to_bytes<'a>(&self, buf: (&'a mut [u8], usize)) -> Result<(&'a mut [u8], usize), GenError> {
        do_gen!(buf,
            gen_be_u8!(0x51) >>
            gen_be_u8!(self.transfer_direction as u8) >>
            gen_be_u8!(self.file_id) >>
            gen_call!(|buf, control_type| ControlType::to_bytes(control_type, buf), &self.control_type)
    )}
}

impl FileControl {
    /// Create new FileControl object.
    pub fn new(transfer_direction: TransferDirection, file_id: u8, control_type: ControlType) -> Self {
        FileControl {
            transfer_direction,
            file_id,
            control_type,
        }
    }
}

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

    encode_decode_test!(
        tox_crypto::crypto_init().unwrap(),
        file_control_encode_decode,
        FileControl::new(TransferDirection::Send, 1, ControlType::Seek(100))
    );
}