Skip to main content

BatteryStatus

Struct BatteryStatus

pub struct BatteryStatus {
    pub millivolts: u16,
    pub percentage: u8,
    pub charge_state: ChargeState,
    pub external_power: ExternalPower,
    pub low_battery: bool,
    pub percentage_estimated: bool,
    pub state_of_charge: Option<u8>,
    pub battery_present: Option<bool>,
}

Expand description

High-level battery/power status for UI and application policy.

Fields§

§millivolts: u16§percentage: u8

Battery percentage for existing UI code.

This is the AXP2101 gauge value when [state_of_charge] is Some(_) and a coarse voltage estimate otherwise.

§charge_state: ChargeState§external_power: ExternalPower§low_battery: bool§percentage_estimated: bool

True when [percentage] is derived from voltage instead of the AXP2101 gauge register.

§state_of_charge: Option<u8>

Preferred battery state-of-charge from AXP2101 register 0xA4.

§battery_present: Option<bool>

Battery presence decoded from AXP2101 status register 0x00 bit 0x08.

Implementations§

impl BatteryStatus

pub const fn new(millivolts: u16, charge_state: ChargeState) -> Self

pub const fn with_power( millivolts: u16, charge_state: ChargeState, external_power: ExternalPower, threshold: LowBatteryThreshold, ) -> Self

pub const fn with_power_and_soc( millivolts: u16, charge_state: ChargeState, external_power: ExternalPower, threshold: LowBatteryThreshold, state_of_charge: Option<u8>, battery_present: Option<bool>, ) -> Self

Trait Implementations§

impl Clone for BatteryStatus

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for BatteryStatus

impl Debug for BatteryStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Eq for BatteryStatus

impl PartialEq for BatteryStatus

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

impl StructuralPartialEq for BatteryStatus

Auto Trait Implementations§

impl Freeze for BatteryStatus

impl RefUnwindSafe for BatteryStatus

impl Send for BatteryStatus

impl Sync for BatteryStatus

impl Unpin for BatteryStatus

impl UnsafeUnpin for BatteryStatus

impl UnwindSafe for BatteryStatus

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Az for T

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> OverflowingAs for T

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.

impl<T> SaturatingAs for T

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

fn saturating_cast_from(src: Src) -> Dst

Casts the value.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> UnwrappedAs for T

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.

impl<T> WrappingAs for T

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.