battery 0.3.0

Cross-platform information about batteries
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
138
139
140
141
142
143
144
145
146
147
148

use std::fmt;
use std::time::Duration;

use crate::{State, Technology};
use crate::types::Device;
use crate::platform::BatteryDevice;

/// Battery instant information representation.
///
/// Consequent calls of the same method will return the same value.
pub struct Battery(BatteryDevice);

impl Battery {

    /// Gets battery current state.
    ///
    /// See [State](enum.State.html) enum for possible values.
    pub fn state(&self) -> State {
        self.0.state()
    }

    /// Gets battery technology.
    ///
    /// See [Technology](enum.Technology.html) enum for possible values.
    ///
    /// ## Compatibility
    ///
    /// * For MacOS this method always returns `None`. This behavior might change later.
    pub fn technology(&self) -> Technology {
        self.0.technology()
    }

    /// Gets battery vendor.
    ///
    /// # Compatibility
    ///
    /// * For MacOS this method always returns `None`. This behavior might change later.
    pub fn vendor(&self) -> Option<&str> {
        self.0.vendor()
    }

    /// Gets battery model.
    pub fn model(&self) -> Option<&str> {
        self.0.model()
    }

    /// Gets battery serial number.
    pub fn serial_number(&self) -> Option<&str> {
        self.0.serial_number()
    }

    /// Gets battery capacity in `0.0..100.0` percents range.
    pub fn capacity(&self) -> f64 {
        self.0.capacity()
    }

    /// Gets battery temperature in Celsius degrees.
    pub fn temperature(&self) -> f64 {
        self.0.temperature()
    }

    /// The amount of energy left in the battery expressed as a percentage between `0.0` and `100.0`.
    pub fn percentage(&self) -> f64 {
        self.0.percentage()
    }

    /// Amount of energy (measured in `Wh`) currently available in the battery.
    pub fn energy(&self) -> f64 {
        self.0.energy()
    }

    /// Amount of energy (measured in `Wh`) in the battery when it's considered full.
    pub fn energy_full(&self) -> f64 {
        self.0.energy_full()
    }

    /// Amount of energy (measured in `Wh`) the battery is designed to hold when it's considered full.
    pub fn energy_full_design(&self) -> f64 {
        self.0.energy_full_design()
    }

    /// Amount of energy being drained from the battery, measured in `W`.
    pub fn energy_rate(&self) -> f64 {
        self.0.energy_rate()
    }

    /// Gets a battery voltage (in `V`).
    pub fn voltage(&self) -> f64 {
        self.0.voltage()
    }

    /// Gets a remaining time till full battery.
    ///
    /// This is an instant value and may different vastly from call to call.
    /// Any aggregation should be made by caller.
    ///
    /// If battery is not charging at the moment, this method will return `None`.
    pub fn time_to_full(&self) -> Option<Duration> {
        self.0.time_to_full()
    }

    /// Gets a remaining time till empty battery.
    ///
    /// This is an instant value and may different vastly from call to call.
    /// Any aggregation should be made by caller.
    ///
    /// If battery is not discharging at the moment, this method will return `None`.
    pub fn time_to_empty(&self) -> Option<Duration> {
        self.0.time_to_empty()
    }

}

impl fmt::Debug for Battery {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("Battery")
            // static info
            .field("vendor", &self.vendor())
            .field("model", &self.model())
            .field("serial_number", &self.serial_number())
            .field("technology", &self.technology())

            // common information
            .field("state", &self.state())
            .field("capacity", &self.capacity())
            .field("temperature", &self.temperature())
            .field("percentage", &self.percentage())

            // energy stats
            .field("energy", &self.energy())
            .field("energy_full", &self.energy_full())
            .field("energy_full_design", &self.energy_full_design())
            .field("energy_rate", &self.energy_rate())
            .field("voltage", &self.voltage())

            // charge stats
            .field("time_to_full", &self.time_to_full())
            .field("time_to_empty", &self.time_to_empty())

            .finish()
    }
}

impl From<BatteryDevice> for Battery {
    fn from(inner: BatteryDevice) -> Self {
        Battery(inner)
    }
}