ipmi-rs-core 0.5.0

A pure rust implementation of the core primitives of the IPMI spec
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

use crate::connection::{LogicalUnit, NetFn};

use super::{Address, Channel, Message};

/// An IPMI request message.
pub struct Request {
    target: RequestTargetAddress,
    message: Message,
}

impl Request {
    /// Create a new IPMI request message.
    ///
    /// The netfn for `request` should be of the `request` variant, see [`Message::new_request`].
    // TODO: don't accept `Message` directly (could be malformed?)
    pub const fn new(request: Message, target: RequestTargetAddress) -> Self {
        Self {
            target,
            message: request,
        }
    }

    /// Get the netfn for the request.
    pub fn netfn(&self) -> NetFn {
        self.message.netfn()
    }

    /// Get the raw value of the netfn for the request.
    pub fn netfn_raw(&self) -> u8 {
        self.message.netfn_raw()
    }

    /// Get the command value for the request.
    pub fn cmd(&self) -> u8 {
        self.message.cmd
    }

    /// Get a shared reference to the data of the request (does not include netfn or command).

    pub fn data(&self) -> &[u8] {
        self.message.data()
    }

    /// Get a mutable reference to the data of the request (does not include netfn or command).
    pub fn data_mut(&mut self) -> &mut [u8] {
        self.message.data_mut()
    }

    /// Get the target for the request.
    pub fn target(&self) -> RequestTargetAddress {
        self.target
    }
}

/// The target address of a request.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum RequestTargetAddress {
    /// A logical unit on the BMC (Board Management Controller).
    Bmc(LogicalUnit),
    /// An address on the BMC or IPMB.
    BmcOrIpmb(Address, Channel, LogicalUnit),
}

impl RequestTargetAddress {
    /// Get the logical unit for the target address.
    pub fn lun(&self) -> LogicalUnit {
        match self {
            RequestTargetAddress::Bmc(lun) | RequestTargetAddress::BmcOrIpmb(_, _, lun) => *lun,
        }
    }
}