Struct i3status_rs::blocks::battery::PowerSupplyDevice

pub struct PowerSupplyDevice {
    device_path: PathBuf,
    allow_missing: bool,
    charge_full: Option<u64>,
    energy_full: Option<u64>,
}

Represents a physical power supply device, as known to sysfs.

Fields

device_path: PathBuf

allow_missing: bool

charge_full: Option<u64>

energy_full: Option<u64>

Implementations

impl PowerSupplyDevice

pub fn from_device(device: &str, allow_missing: bool) -> Result<Self, Error>

Use the power supply device device, as found in the /sys/class/power_supply directory. Raises an error if the directory for that device cannot be found and allow_missing is false.

Trait Implementations

impl BatteryDevice for PowerSupplyDevice

fn is_available(&self) -> bool

Query whether the device is available. Batteries can be hot-swappable and configurations may be used for multiple devices (desktop AND laptop).

fn refresh_device_info(&mut self) -> Result<(), Error>

Logic for getting some static battery specs. An error may be thrown when these specs cannot be found or if the device is unexpectedly missing.

fn status(&self) -> Result<String, Error>

Query the device status. One of "Full", "Charging", "Discharging", or "Unknown". Thinkpad batteries also report "Not charging", which for our purposes should be treated as equivalent to full.

fn capacity(&self) -> Result<u64, Error>

Query the device's current capacity, as a percent.

fn time_remaining(&self) -> Result<u64, Error>

Query the estimated time remaining, in minutes, before (dis)charging is complete.

fn power_consumption(&self) -> Result<u64, Error>

Query the current power consumption, in uW.