hid-report 1.0.0

handle USB HID report descriptors
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

use std::fmt::Display;

use crate::__data_size;

/// Items that are reserved for future use.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Reserved([u8; 5]);

impl AsRef<[u8]> for Reserved {
    fn as_ref(&self) -> &[u8] {
        let end = __data_size(self.0[0]) + 1;
        &self.0[..end]
    }
}

impl Reserved {
    /// Create an item with size check.
    pub fn new(raw: &[u8]) -> Result<Self, crate::HidError> {
        if raw.is_empty() {
            return Err(crate::HidError::EmptyRawInput);
        };
        let expected = crate::__data_size(raw[0]);
        if expected + 1 != raw.len() {
            return Err(crate::HidError::DataSizeNotMatch {
                expected,
                provided: raw.len() - 1,
            });
        };
        let mut storage = [0; 5];
        storage[..raw.len()].copy_from_slice(raw);
        Ok(Self(storage))
    }

    /// Create an item without size check.
    ///
    /// # Safety
    ///
    /// Must ensure that the size part in the prefix is correct.
    pub unsafe fn new_unchecked(raw: &[u8]) -> Self {
        let mut storage = [0; 5];
        storage[..raw.len()].copy_from_slice(raw);
        Self(storage)
    }

    /// Get prefix part of the item. Equivalent to `item.as_ref()[0]`.
    pub fn prefix(&self) -> u8 {
        self.0[0]
    }

    /// Get data part of the item. Equivalent to `&item.as_ref()[1..]`.
    pub fn data(&self) -> &[u8] {
        let end = __data_size(self.0[0]) + 1;
        &self.0[1..end]
    }

    /// Set data part of the item.
    ///
    /// *NOTE*: data size must be: 0, 1, 2 or 4.
    pub fn set_data(&mut self, data: &[u8]) -> Result<&mut Self, crate::HidError> {
        crate::__set_data_size(&mut self.0[0], data)?;
        self.data_mut().copy_from_slice(data);
        Ok(self)
    }

    /// Get mutable data part of the item.
    pub fn data_mut(&mut self) -> &mut [u8] {
        let end = __data_size(self.0[0]) + 1;
        &mut self.0[1..end]
    }
}

impl Display for Reserved {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self.0.len() {
            1.. => write!(f, "Reserved"),
            0 => unreachable!(),
        }
    }
}