wayle-battery 0.1.2

Battery monitoring service with reactive state
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

use std::sync::Arc;

use derive_more::Debug;
use tokio_util::sync::CancellationToken;

use crate::{builder::BatteryServiceBuilder, core::device::Device, error::Error};

/// Battery service for monitoring power devices via UPower.
///
/// Provides a high-level interface to UPower's battery monitoring,
/// allowing access to battery state, capacity, charge status, and reactive
/// monitoring of changes through the D-Bus interface.
#[derive(Debug)]
pub struct BatteryService {
    #[debug(skip)]
    pub(crate) cancellation_token: CancellationToken,

    /// The UPower battery device proxy for power metrics and charging state.
    pub device: Arc<Device>,
}

impl BatteryService {
    /// Creates a new battery service for the default DisplayDevice.
    ///
    /// The DisplayDevice is UPower's composite device that represents the overall
    /// battery status, automatically handling multiple batteries if present.
    /// This is the recommended way to monitor battery status for most applications.
    ///
    /// # Errors
    ///
    /// Returns `Error::InvalidObjectPath` if the device path is invalid, or
    /// `Error::Dbus` if D-Bus connection fails.
    pub async fn new() -> Result<Self, Error> {
        Self::builder().build().await
    }

    /// Returns a builder for configuring a BatteryService.
    ///
    /// The builder allows monitoring a specific battery device rather than
    /// the default aggregated DisplayDevice.
    pub fn builder() -> BatteryServiceBuilder {
        BatteryServiceBuilder::new()
    }
}

impl Drop for BatteryService {
    fn drop(&mut self) {
        self.cancellation_token.cancel();
    }
}