modbius-core 0.1.0

Modbius core parsing library
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use core::{convert::TryFrom, ops::Not};

use crate::ModbusSerializationError;

/// Bit addressable modbus data item state helper type.
///
/// This enum works similiar to bool but adds some helper functionality
#[repr(u8)]
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
pub enum BitState {
    Off = 0,
    On = 1,
}

impl BitState {
    pub fn is_on(self) -> bool {
        self.into()
    }
}

impl Default for BitState {
    fn default() -> BitState {
        BitState::Off
    }
}

impl TryFrom<u16> for BitState {
    type Error = ModbusSerializationError;
    fn try_from(value: u16) -> Result<Self, Self::Error> {
        match value {
            0 => Ok(Self::Off),
            0xFF00 => Ok(Self::On),
            _ => Err(ModbusSerializationError::InvalidValue)
        }
    }
}

impl Into<u16> for BitState {
    fn into(self) -> u16 {
        match self { 
            Self::Off => 0,
            Self::On => 0xFF00,
        }
    }
}

impl From<bool> for BitState {
    fn from(b: bool) -> Self {
        if b {
            Self::On
        } else {
            Self::Off
        }
    }
}

impl Into<bool> for BitState {
    fn into(self) -> bool {
        match self {
            Self::Off => false,
            Self::On => true,
        }
    }
}

impl Not for BitState {
    type Output = Self;

    fn not(self) -> Self::Output {
        match self {
            BitState::On => BitState::Off,
            BitState::Off => BitState::On,
        }
    }
}

#[cfg(test)]
mod bitstate_test {
    use core::convert::TryFrom;

    use crate::{BitState, ModbusSerializationError};

    #[test]
    fn from_bool_true() {
        let state_on = BitState::from(true);
        assert_eq!(state_on, BitState::On);
        assert_eq!(!state_on, BitState::Off);
        assert_eq!(true, state_on.into());
        assert_eq!(0xFF00u16, state_on.into());
    }


    #[test]
    fn from_bool_false() {
        let state_on = BitState::from(false);
        assert_eq!(state_on, BitState::Off);
        assert_eq!(!state_on, BitState::On);
        assert_eq!(false, state_on.into());
        assert_eq!(0u16, state_on.into());
    }

    #[test]
    fn from_u16_on() {
        let state_on = BitState::try_from(0xFF00).unwrap();
        assert_eq!(state_on, BitState::On);
        assert_eq!(!state_on, BitState::Off);
        assert_eq!(true, state_on.into());
        assert_eq!(0xFF00u16, state_on.into());
    }

    #[test]
    fn from_u16_off() {
        let state_on = BitState::try_from(0).unwrap();
        assert_eq!(state_on, BitState::Off);
        assert_eq!(!state_on, BitState::On);
        assert_eq!(false, state_on.into());
        assert_eq!(0u16, state_on.into());
    }

    #[test]
    fn from_u16_invalid0() {
        let invalid = BitState::try_from(0xF0FF).unwrap_err();
        assert_eq!(invalid, ModbusSerializationError::InvalidValue);
    }

    #[test]
    fn from_u16_invalid1() {
        let invalid = BitState::try_from(0xFFFF).unwrap_err();
        assert_eq!(invalid, ModbusSerializationError::InvalidValue);
    }

    #[test]
    fn from_u16_invalid2() {
        let invalid = BitState::try_from(1).unwrap_err();
        assert_eq!(invalid, ModbusSerializationError::InvalidValue);
    }
}