Struct acpi_client::battery::BatteryInfo

pub struct BatteryInfo {
    pub name: String,
    pub remaining_capacity: u32,
    pub present_rate: u32,
    pub voltage: u32,
    pub design_capacity: u32,
    pub last_capacity: u32,
    pub time_remaining: Duration,
    pub percentage: f32,
    pub state: ChargingState,
}

Metadata pertaining to a battery.

Fields

name: String

The name used by ACPI to refer to the device.

remaining_capacity: u32

The charge remaining in the battery in units of mAh.

present_rate: u32

The rate at which the charge of the battery is changing in mA.

voltage: u32

The current voltage of the battery in mV.

design_capacity: u32

The charge available in the battery at the time of manufacture in units of mAh.

last_capacity: u32

The charge available in the battery at the last time the device was charged to full in units of mAh.

time_remaining: Duration

The time remaining until the battery reaches full charge or empty.

percentage: f32

The ratio of the remaining charge to the full charge.

state: ChargingState

The state of the battery's charging.

Methods

impl BatteryInfo

pub fn new(path: &Path) -> Result<BatteryInfo, Box<dyn Error>>

Returns a battery corresponding to a given ACPI device path.

Arguments

• path - The path to the ACPI device.

Example

let directory = std::path::Path::new("/sys/class/power_supply/BAT1");
let ps_info = acpi_client::BatteryInfo::new(&directory);