openrgb 0.1.2

OpenRGB SDK client
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

use std::mem::size_of;

use async_trait::async_trait;
use rgb::RGB8;

use crate::data::{OpenRGBReadable, OpenRGBWritable};
use crate::OpenRGBError;
use crate::protocol::{OpenRGBReadableStream, OpenRGBWritableStream};

/// RGB controller color, aliased to [rgb] crate's [RGB8] type.
///
/// See [Open SDK documentation](https://gitlab.com/CalcProgrammer1/OpenRGB/-/wikis/OpenRGB-SDK-Documentation) for more information.
pub type Color = RGB8;

#[async_trait]
impl OpenRGBReadable for Color {
    async fn read(stream: &mut impl OpenRGBReadableStream, protocol: u32) -> Result<Self, OpenRGBError> {
        let r = stream.read_value(protocol).await?;
        let g = stream.read_value(protocol).await?;
        let b = stream.read_value(protocol).await?;
        let _padding = stream.read_value::<u8>(protocol).await?;
        Ok(Color { r, g, b })
    }
}

#[async_trait]
impl OpenRGBWritable for Color {
    fn size(&self, _protocol: u32) -> usize {
        4 * size_of::<u8>()
    }

    async fn write(self, stream: &mut impl OpenRGBWritableStream, protocol: u32) -> Result<(), OpenRGBError> {
        stream.write_value(self.r, protocol).await?;
        stream.write_value(self.g, protocol).await?;
        stream.write_value(self.b, protocol).await?;
        stream.write_value(0u8, protocol).await?;
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use std::error::Error;

    use tokio_test::io::Builder;

    use crate::data::Color;
    use crate::DEFAULT_PROTOCOL;
    use crate::protocol::{OpenRGBReadableStream, OpenRGBWritableStream};
    use crate::tests::setup;

    #[tokio::test]
    async fn test_read_001() -> Result<(), Box<dyn Error>> {
        setup()?;

        let mut stream = Builder::new()
            .read(&[37_u8, 54_u8, 126_u8, 0_u8])
            .build();

        assert_eq!(stream.read_value::<Color>(DEFAULT_PROTOCOL).await?, Color { r: 37, g: 54, b: 126 });

        Ok(())
    }

    #[tokio::test]
    async fn test_write_001() -> Result<(), Box<dyn Error>> {
        setup()?;

        let mut stream = Builder::new()
            .write(&[37_u8, 54_u8, 126_u8, 0_u8])
            .build();

        stream.write_value(Color { r: 37, g: 54, b: 126 }, DEFAULT_PROTOCOL).await?;

        Ok(())
    }
}