Struct BacklightState 

pub struct BacklightState {
    pub enabled: bool,
    pub mode: BacklightMode,
    pub status: BacklightStatus,
    pub current_level: u8,
    pub nb_levels: u8,
    pub power_save: bool,
    pub controls: BacklightControls,
}

Snapshot of a keyboard’s backlight, merged from the 0x1982 getBacklightConfig and getBacklightInfo responses.

Crosses the agent↔GUI IPC, so field order is wire format — changes require a PROTOCOL_VERSION bump (guarded by openlogi-ipc/tests/wire_format.rs).

Fields

enabled: bool

Whether the backlight system is enabled at all. When false the firmware keeps the LEDs dark no matter what the sensors report, and Self::status reads BacklightStatus::DisabledBySoftware.

mode: BacklightMode

How the level is chosen while the backlight is enabled.

status: BacklightStatus

Why the backlight is in its current state.

current_level: u8

Current brightness level, 0 (off) up to Self::nb_levels minus one.

nb_levels: u8

Number of user-selectable brightness levels the device reports.

power_save: bool

Whether battery saving is on: the firmware turns the backlight off when the battery runs low.

serde(default) only keeps recorded JSON fixtures that predate the field loading; the IPC encoding always carries it.

controls: BacklightControls

Which BacklightChanges the keyboard accepts.

Implementations

impl BacklightState

pub fn accepts(self, change: BacklightChange) -> bool

Whether the keyboard accepts change right now: the control exists and, for a level, the level is in range.

pub fn is_automatic(self) -> bool

Whether the ambient-light sensor chooses the level — the firmware’s automatic mode, or the temporary level the backlight keys set on top of it.

pub fn is_dark(self) -> bool

Whether the LEDs are dark right now, for whatever reason — software disable, critical battery, a saturated ambient-light sensor, or a zero manual level.

pub fn changed(self, change: BacklightChange) -> BacklightState

The backlight this one becomes once the keyboard keeps change, as far as the change alone decides — what software can show before the keyboard reads back, and what a keyboard double answers.

The firmware owns the rest and it is kept: a critical-battery shutoff stays in force, and a status the mode did not change — a saturated sensor, say — stands. Turning the backlight off always reads BacklightStatus::DisabledBySoftware, the status the keyboard reports for it. change is not checked against Self::accepts.

Trait Implementations

impl Clone for BacklightState

fn clone(&self) -> BacklightState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BacklightState

impl Debug for BacklightState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BacklightState

fn deserialize<__D>( __deserializer: __D, ) -> Result<BacklightState, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BacklightState

impl PartialEq for BacklightState

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BacklightState

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BacklightState