Struct BatteryInfo

pub struct BatteryInfo {
    pub status: Option<BatteryStatus>,
    pub charge_status: Option<ChargeStatus>,
    pub charge_source: Option<ChargeSource>,
    pub level_percent: Option<f32>,
    pub level_status: Option<LevelStatus>,
    pub health: Option<HealthStatus>,
    pub time_remaining: Option<TimeRemaining>,
    pub timestamp: Option<i64>,
    pub present_voltage_mv: Option<u32>,
    pub remaining_capacity_uah: Option<u32>,
    pub battery_spec: Option<BatterySpec>,
    /* private fields */
}

Current battery state information

Fields

status: Option<BatteryStatus>

General battery status with respect to presence & availability

charge_status: Option<ChargeStatus>

The current state of the battery with respect to charging

charge_source: Option<ChargeSource>

The charge source while battery is actively charging. When not actively charging, this will reflect that the source is NONE (not charging) or UNKNOWN.

level_percent: Option<f32>

Battery level in percentage. Level percent is only available if level status is known.

level_status: Option<LevelStatus>

Battery level as a general status, including low and critical

health: Option<HealthStatus>

Overall battery health

time_remaining: Option<TimeRemaining>

Time remaining relative to the current charge status

timestamp: Option<i64>

Timestamp to distinguish between latest and stale status

present_voltage_mv: Option<u32>

Forward the voltage level in mv

remaining_capacity_uah: Option<u32>

Forward the battery capqacity in uAh

battery_spec: Option<BatterySpec>

Battery spec

Trait Implementations

impl Clone for BatteryInfo

fn clone(&self) -> BatteryInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatteryInfo

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

Formats the value using the given formatter.

impl<D> Decode<BatteryInfo, D> for BatteryInfo

where D: ResourceDialect,

fn new_empty() -> BatteryInfo

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<(), Error>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for BatteryInfo

fn default() -> BatteryInfo

Returns the “default value” for a type.

impl<D> Encode<BatteryInfo, D> for &BatteryInfo

where D: ResourceDialect,

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

impl PartialEq for BatteryInfo

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for BatteryInfo

type Owned = BatteryInfo

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for BatteryInfo

type Borrowed<'a> = &'a BatteryInfo

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow( value: &<BatteryInfo as TypeMarker>::Owned, ) -> <BatteryInfo as ValueTypeMarker>::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for BatteryInfo

impl StructuralPartialEq for BatteryInfo