shdp 1.2.0

A new protocol (SHDP)
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

//!
//! Defines everything for the 0x0006 event.
//!

use bitvec::order::Msb0;
use serde_json::Value;

use crate::protocol::prelude::common::{
    bits::{util::BitReversible, BitDecoder, Frame},
    error::Error,
    event::{EventDecoder, EventEncoder},
};

///
/// Describe an interaction response.
///
pub struct InteractionResponse {
    decoder: BitDecoder<Msb0>,
    /// The request ID.
    pub request_id: u64,
    /// The file's content.
    pub response: Option<Value>,
}

impl InteractionResponse {
    ///
    /// Creates a new [InteractionResponse].
    ///
    /// # Arguments
    /// * `decoder` - The [`BitDecoder<Msb0>`] to decode the request.
    ///
    /// # Returns
    /// * [InteractionResponse] - The created [InteractionResponse].
    ///
    /// # Example
    /// ```rust
    /// use shdp::prelude::client::versions::v1::r0x0006::InteractionResponse;
    /// use shdp::prelude::common::bits::BitDecoder;
    /// use bitvec::order::Msb0;
    ///
    /// let decoder = BitDecoder::<Msb0>::new(Vec::new());
    /// let response = InteractionResponse::new(decoder);
    ///
    /// // These are default values.
    /// assert_eq!(response.request_id, 0);
    /// assert_eq!(response.response, None);
    /// ```
    pub fn new(decoder: BitDecoder<Msb0>) -> Self {
        if cfg!(feature = "debug") {
            println!("[\x1b[38;5;187mSHDP\x1b[0m] \x1b[38;5;21m0x0006\x1b[0m received");
        }

        InteractionResponse {
            decoder,
            request_id: 0,
            response: None,
        }
    }
}

impl EventDecoder<Msb0> for InteractionResponse {
    fn decode(&mut self, frame: Frame<Msb0>) -> Result<(), Error> {
        let upper_id = self.decoder.read_data(32)? >> 0;
        let lower_id = self.decoder.read_data(32)? >> 0;
        self.request_id = (u64::from(upper_id) << 32) + u64::from(lower_id);

        // Read bytes till the end.
        let mut bytes = Vec::<u8>::new();

        for _ in 0..(frame.data_size - 64) / 8 {
            bytes.push(self.decoder.read_data(8)? as u8);
        }

        let data = String::from_utf8(bytes).unwrap();

        self.response = Some(match serde_json::from_str(&data) {
            Ok(value) => value,
            Err(_) => Value::Null,
        });

        Ok(())
    }

    fn get_responses(
        &self,
    ) -> Result<Vec<Box<dyn EventEncoder<<Msb0 as BitReversible>::Opposite>>>, Error> {
        Ok(Vec::new())
    }
}