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

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

use bitvec::order::Lsb0;

use crate::protocol::prelude::common::{bits::BitEncoder, error::Error, event::EventEncoder};

///
/// Describe an component needs request.
///
pub struct ComponentNeedsRequest {
    encoder: BitEncoder<Lsb0>,
    component_name: String,
}

impl ComponentNeedsRequest {
    ///
    /// Creates a new [ComponentNeedsRequest].
    ///
    /// # Arguments
    /// * `component_name` - The component name.
    ///
    /// # Returns
    /// * [ComponentNeedsRequest] - The created [ComponentNeedsRequest].
    ///
    /// # Example
    /// ```rust
    /// use shdp::prelude::client::versions::v1::c0x0000::ComponentNeedsRequest;
    ///
    /// let request = ComponentNeedsRequest::new("component_name".to_string());
    /// ```
    ///
    pub fn new(component_name: String) -> Self {
        if cfg!(feature = "debug") {
            println!(
                "[\x1b[38;5;187mSHDP\x1b[0m] \x1b[38;5;21m0x0000\x1b[0m created ({})",
                component_name
            );
        }

        ComponentNeedsRequest {
            encoder: BitEncoder::<Lsb0>::new(),
            component_name,
        }
    }
}

impl EventEncoder<Lsb0> for ComponentNeedsRequest {
    fn encode(&mut self) -> Result<(), Error> {
        self.encoder.add_bytes(self.component_name.as_bytes())?;

        Ok(())
    }

    fn get_encoder(&self) -> &BitEncoder<Lsb0> {
        &self.encoder
    }

    fn get_event(&self) -> u16 {
        0x0000
    }
}