rust-ipmi 0.1.1

IPMI client library for rust
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

use bitvec::prelude::*;

use crate::err::RMCPHeaderError;

use bitvec::{field::BitField, prelude::Msb0, slice::BitSlice};

#[derive(Clone, Debug)]
pub struct RmcpHeader {
    pub version: u8,         // 0x06 for RMCP Version 1.0
    pub reserved: u8,        // 0x00
    pub sequence_number: u8, // 255 if no RMCP ACK; 0-254 if RMCP ACK desired
    pub rmcp_ack: bool,
    pub message_class: MessageClass,
}

impl TryFrom<&[u8]> for RmcpHeader {
    type Error = RMCPHeaderError;

    fn try_from(value: &[u8]) -> Result<Self, RMCPHeaderError> {
        if value.len() != 4 {
            Err(RMCPHeaderError::WrongLength)?
        }

        let third_byte_slice = BitSlice::<u8, Msb0>::from_element(&value[3]);

        Ok(RmcpHeader {
            version: value[0],
            reserved: value[1],
            sequence_number: value[2],
            rmcp_ack: third_byte_slice[0],
            message_class: third_byte_slice[4..].load::<u8>().try_into()?,
        })
    }
}

impl Into<Vec<u8>> for RmcpHeader {
    fn into(self) -> Vec<u8> {
        let result = [self.version, self.reserved, self.sequence_number, {
            let mut bv: BitVec<u8, Msb0> = bitvec![u8, Msb0; 0;8];
            bv[0..1].store::<u8>(self.rmcp_ack as u8);
            bv[4..].store::<u8>(self.message_class.into());
            let message_class = bv[..].load::<u8>();
            message_class
        }];
        let mut vec_result = Vec::new();
        vec_result.extend_from_slice(result.as_slice());
        vec_result
    }
}

// Doesn't apply....yet
// impl RmcpHeader {
//     pub fn new(version: u8, sequence_number: u8, message_class: MessageClass) -> RmcpHeader {
//         RmcpHeader {
//             version,
//             reserved: 0x00,
//             sequence_number,
//             rmcp_ack: false,
//             message_class,
//         }
//     }
// }

impl Default for RmcpHeader {
    fn default() -> RmcpHeader {
        RmcpHeader {
            version: 0x06,
            reserved: 0,
            sequence_number: 0xff,
            rmcp_ack: false,
            message_class: MessageClass::IPMI,
        }
    }
}

#[derive(Clone, Debug)]
pub enum MessageClass {
    ASF,
    IPMI,
    OEM,
}

impl TryFrom<u8> for MessageClass {
    type Error = RMCPHeaderError;

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        match value {
            0x6 => Ok(MessageClass::ASF),
            0x7 => Ok(MessageClass::IPMI),
            0x8 => Ok(MessageClass::OEM),
            _ => Err(RMCPHeaderError::UnsupportedMessageClass(value)),
        }
    }
}

impl Into<u8> for MessageClass {
    fn into(self) -> u8 {
        match self {
            MessageClass::ASF => 6,
            MessageClass::IPMI => 7,
            MessageClass::OEM => 8,
        }
    }
}