Enum BatteryRequest 

pub enum BatteryRequest {
    GetSpec {
        responder: BatteryGetSpecResponder,
    },
    GetStatus {
        responder: BatteryGetStatusResponder,
    },
    ConfigureWatch {
        options: WatchOptions,
        responder: BatteryConfigureWatchResponder,
    },
    Watch {
        lease: Option<EventPair>,
        responder: BatteryWatchResponder,
    },
    #[non_exhaustive]
    _UnknownMethod {
        ordinal: u64,
        control_handle: BatteryControlHandle,
        method_type: MethodType,
    },
}

Diagnostic and telemetry interface for battery hardware.

This is a read-only protocol that supports multiple concurrent clients.

Variants

GetSpec

Retrieves the static specification of the battery.

Returns:

• spec: Static hardware characteristics and driver capabilities of the battery.

Errors:

• NOT_SUPPORTED: Hardware does not supply a static specification.
• IO: Communication failure with the fuel gauge hardware (e.g. I2C transfer failure).
• INTERNAL: Internal driver error.

Fields

responder: BatteryGetSpecResponder

GetStatus

Retrieves an instantaneous snapshot of the battery status.

Returns:

• status: Complete current telemetry snapshot of battery metrics.

Errors:

• IO: Communication failure with the fuel gauge hardware (e.g. I2C transfer failure).
• INTERNAL: Internal driver error.

Fields

responder: BatteryGetStatusResponder

ConfigureWatch

Configures the fields of interest and wake triggers for this client connection.

The driver filters the requested masks against hardware capabilities and returns the effective configuration in effective_options.

• Partially supported options: If some requested fields are supported and others are not (e.g., requesting passive fields like voltage_uv or current_ua that do not support active interrupt notifications), the driver enables the supported fields and returns the active subset in effective_options. The call succeeds (Ok).
• Fully unsupported options: If non-empty masks were specified but NONE of the requested fields are supported, the driver returns NOT_SUPPORTED.

If ConfigureWatch is never called, Watch defaults to returning on ANY supported field change. The driver aggregates constraints across all clients to determine hardware reporting rates.

ConfigureWatch may be called at any time, including while a Watch is pending. The new masks take effect immediately and apply to that pending call. Change detection continues to compare against the status last delivered on this connection, so a field that changed before the reconfiguration can still resolve the pending Watch.

Parameters:

• options: Requested watch options. Both interest and wake_on are optional.

Returns:

• effective_options: The subset of requested options supported and enabled by the driver.

Errors:

• NOT_SUPPORTED: Non-empty options were requested, but none of the requested interest/wake fields are supported by the driver.

On error the connection’s configuration is left unchanged; a failed call never partially applies.

Fields

options: WatchOptions

responder: BatteryConfigureWatchResponder

Watch

Change notification for battery state using a hanging-get pattern.

The first call returns the full current hardware state immediately. Subsequent calls block until a state change matches the masks in [ConfigureWatch]. Each return contains a complete telemetry snapshot of all current battery fields, not a sparse delta.

At most one Watch call may be outstanding per connection; concurrent calls fail with ALREADY_WATCHING.

Parameters:

• lease: An optional power lease token used to coordinate handoff between client and server, preventing the system from suspending before critical battery events are handled. If omitted, no lease coordination is performed. If the driver advertises no wake_on fields in Spec.supported_options, lease is ignored and wake_lease is always omitted.

Returns:

• status: Complete current telemetry snapshot of the battery.
• wake_lease: An optional lease token provided if the change triggered a wake_on condition. Omitted if the change did not trigger a wake condition or if suspend coordination is inactive.

Errors:

• ALREADY_WATCHING: A Watch call is already pending on this connection.
• IO: Communication failure with the fuel gauge hardware (e.g. I2C transfer failure).
• INTERNAL: Internal driver error.

Fields

lease: Option<EventPair>

responder: BatteryWatchResponder

#[non_exhaustive]

_UnknownMethod

An interaction was received which does not match any known method.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

ordinal: u64

Ordinal of the method that was called.

control_handle: BatteryControlHandle

method_type: MethodType

Implementations

impl BatteryRequest

pub fn into_get_spec(self) -> Option<BatteryGetSpecResponder>

pub fn into_get_status(self) -> Option<BatteryGetStatusResponder>

pub fn into_configure_watch( self, ) -> Option<(WatchOptions, BatteryConfigureWatchResponder)>

pub fn into_watch(self) -> Option<(Option<EventPair>, BatteryWatchResponder)>

pub fn method_name(&self) -> &'static str

Name of the method defined in FIDL

Trait Implementations

impl Debug for BatteryRequest

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

Formats the value using the given formatter.