openrgb2 0.3.0

OpenRGB SDK client, successor to openrgb
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

mod effect;

#[expect(unused_imports, reason = "Plugin effect api todo")]
pub use effect::*;

use crate::{DeserFromBuf, ReceivedMessage};

/// Data for `OpenRGB` plugins.
#[derive(Debug)]
pub struct PluginData {
    /// Plugin name
    name: String,
    /// Description of plugin
    description: String,
    /// Plugin version
    version: String,
    /// Index of this plugin. This is its id in `plugin_specific` commands.
    index: u32,
    /// Plugin's protocol version.
    plugin_protocol_version: u32,
}

impl PluginData {
    /// Returns the name of this plugin.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Returns the description of this plugin.
    pub fn description(&self) -> &str {
        &self.description
    }

    /// Returns the version of this plugin.
    pub fn version(&self) -> &str {
        &self.version
    }

    /// Returns the index of this plugin.
    pub fn index(&self) -> u32 {
        self.index
    }

    /// Returns the protocol version of this plugin.
    pub fn plugin_protocol_version(&self) -> u32 {
        self.plugin_protocol_version
    }
}

impl DeserFromBuf for PluginData {
    fn deserialize(buf: &mut ReceivedMessage<'_>) -> crate::OpenRgbResult<Self> {
        let name = buf.read_value()?;
        let description = buf.read_value()?;
        let version = buf.read_value()?;
        let index = buf.read_value()?;
        let plugin_protocol_version = buf.read_value()?;
        Ok(PluginData {
            name,
            description,
            version,
            index,
            plugin_protocol_version,
        })
    }
}