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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

use crate::{
    SerToBuf, WriteMessage,
    protocol::serialize::{DeserFromBuf, ReceivedMessage},
};

/// Option that can be used to represent values not supported by the current protocol version.
///
/// If protocol version is suppported, this is just an `T`.
/// If not, then this is always `ProtocolOption::UnsupportedVersion`.
///
/// Useful when determining sizes of data structures that contains fields that may not be supported by the current protocol version.
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum ProtocolOption<const VER: usize, T> {
    /// Value is supported by the current protocol version.
    Some(T),
    /// Value is not supported by the current protocol version.
    UnsupportedVersion,
}

impl<const VER: usize, T: Default> std::default::Default for ProtocolOption<VER, T> {
    fn default() -> Self {
        ProtocolOption::Some(T::default())
    }
}

impl<const VER: usize, T> From<ProtocolOption<VER, T>> for Option<T> {
    fn from(value: ProtocolOption<VER, T>) -> Self {
        match value {
            ProtocolOption::Some(v) => Some(v),
            ProtocolOption::UnsupportedVersion => None,
        }
    }
}

impl<const VER: usize, T> ProtocolOption<VER, T> {
    /// Creates a new `ProtocolOption` with the given value if the protocol version is supported.
    pub fn new(val: T, version: usize) -> Self {
        if version < VER {
            return Self::UnsupportedVersion;
        }
        Self::Some(val)
    }

    /// Replaces the value in this `ProtocolOption`
    pub fn replace(&mut self, val: T) {
        match self {
            Self::Some(_) => *self = Self::Some(val),
            Self::UnsupportedVersion => (),
        }
    }

    /// Returns `Some(&T)` if the value is supported by the current protocol version, otherwise `None`.
    pub fn value(&self) -> Option<&T> {
        match self {
            Self::Some(v) => Some(v),
            Self::UnsupportedVersion => None,
        }
    }

    /// Returns `Some(&mut T)` if the value is supported by the current protocol version, otherwise `None`.
    pub fn value_mut(&mut self) -> Option<&mut T> {
        match self {
            Self::Some(v) => Some(v),
            Self::UnsupportedVersion => None,
        }
    }
}

impl<const VER: usize, T> DeserFromBuf for ProtocolOption<VER, T>
where
    T: DeserFromBuf,
{
    fn deserialize(buf: &mut ReceivedMessage<'_>) -> crate::OpenRgbResult<Self> {
        if buf.protocol_version() < VER as u32 {
            return Ok(ProtocolOption::UnsupportedVersion);
        }
        let val = T::deserialize(buf)?;
        Ok(ProtocolOption::Some(val))
    }
}

impl<const VER: usize, T> SerToBuf for ProtocolOption<VER, T>
where
    T: SerToBuf,
{
    fn serialize(&self, buf: &mut WriteMessage) -> crate::OpenRgbResult<()> {
        if buf.protocol_version() < VER as u32 {
            return Ok(());
        }

        match self {
            Self::Some(v) => v.serialize(buf),
            Self::UnsupportedVersion => Ok(()), // No write if this came from unsupported read
        }
    }
}