Struct dmc::battery::BatteryState

pub struct BatteryState {
    pub status: Knowledge<BatteryStatus>,
    pub estimated_time_remaining: Knowledge<Duration>,
    pub percentage_remaining: Knowledge<f32>,
}

The battery's state and useful associated information - Get it for the user's device with the associated query() function.

It's all packed into a single struct because on most platforms, it's cheaper to query everything at once rather than "coming back" for individual pieces of information.

Fields

status: Knowledge<BatteryStatus>

estimated_time_remaining: Knowledge<Duration>

percentage_remaining: Knowledge<f32>

The value is between 0 and 1 (both inclusive).

Methods

impl BatteryState

fn query() -> Self

Query the user's device's battery's current state.

You should consider this operation as expensive, and the result is not implicitly cached - it's up to you to cache it by yourself if you want to.

Trait Implementations

impl Debug for BatteryState

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for BatteryState

fn default() -> BatteryState

Returns the "default value" for a type.

impl Copy for BatteryState

impl Clone for BatteryState

fn clone(&self) -> BatteryState

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq for BatteryState

fn eq(&self, __arg_0: &BatteryState) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &BatteryState) -> bool

This method tests for !=.