libmedium 0.3.0

Library to interface with lm_sensors
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

//! Module containing the current sensors and their related functionality.

use super::*;
use crate::hwmon::*;
use crate::units::Current;
use crate::{Parseable, ParsingResult};

#[cfg(feature = "writable")]
use std::convert::TryFrom;
use std::path::{Path, PathBuf};

/// Trait implemented by all current sensors.
pub trait CurrSensor: SensorBase {}

impl<S: CurrSensor> Sensor<Current> for S {}
impl<S: CurrSensor> Min<Current> for S {}
impl<S: CurrSensor> Max<Current> for S {}
impl<S: CurrSensor> LowCrit<Current> for S {}
impl<S: CurrSensor> Crit<Current> for S {}
impl<S: CurrSensor> Average<Current> for S {}
impl<S: CurrSensor> Lowest<Current> for S {}
impl<S: CurrSensor> Highest<Current> for S {}

/// Struct that represents a read only current sensor.
#[derive(Debug, Clone)]
pub struct ReadOnlyCurr {
    hwmon_path: PathBuf,
    index: u16,
}

impl SensorBase for ReadOnlyCurr {
    fn base(&self) -> &'static str {
        "curr"
    }

    fn index(&self) -> u16 {
        self.index
    }

    fn hwmon_path(&self) -> &Path {
        self.hwmon_path.as_path()
    }
}

impl Parseable for ReadOnlyCurr {
    type Parent = ReadOnlyHwmon;

    fn parse(parent: &Self::Parent, index: u16) -> ParsingResult<Self> {
        let curr = Self {
            hwmon_path: parent.path().to_path_buf(),
            index,
        };

        inspect_sensor(curr)
    }
}

impl CurrSensor for ReadOnlyCurr {}

#[cfg(feature = "writable")]
impl From<ReadWriteCurr> for ReadOnlyCurr {
    fn from(write_curr: ReadWriteCurr) -> ReadOnlyCurr {
        ReadOnlyCurr {
            hwmon_path: write_curr.hwmon_path,
            index: write_curr.index,
        }
    }
}

/// Struct that represents a read/write current sensor.
#[cfg(feature = "writable")]
#[derive(Debug, Clone)]
pub struct ReadWriteCurr {
    hwmon_path: PathBuf,
    index: u16,
}

#[cfg(feature = "writable")]
impl SensorBase for ReadWriteCurr {
    fn base(&self) -> &'static str {
        "curr"
    }

    fn index(&self) -> u16 {
        self.index
    }

    fn hwmon_path(&self) -> &Path {
        self.hwmon_path.as_path()
    }
}

#[cfg(feature = "writable")]
impl Parseable for ReadWriteCurr {
    type Parent = ReadWriteHwmon;

    fn parse(parent: &Self::Parent, index: u16) -> ParsingResult<Self> {
        let curr = Self {
            hwmon_path: parent.path().to_path_buf(),
            index,
        };

        inspect_sensor(curr)
    }
}

#[cfg(feature = "writable")]
impl CurrSensor for ReadWriteCurr {}
#[cfg(feature = "writable")]
impl WritableSensorBase for ReadWriteCurr {}

#[cfg(feature = "writable")]
impl TryFrom<ReadOnlyCurr> for ReadWriteCurr {
    type Error = Error;

    fn try_from(value: ReadOnlyCurr) -> std::result::Result<Self, Self::Error> {
        let read_write = ReadWriteCurr {
            hwmon_path: value.hwmon_path,
            index: value.index,
        };

        if read_write.supported_write_sub_functions().is_empty() {
            return Err(Error::InsufficientRights {
                path: read_write.hwmon_path.join(format!(
                    "{}{}",
                    read_write.base(),
                    read_write.index(),
                )),
            });
        }

        Ok(read_write)
    }
}