Skip to main content

LightSnapshot

Struct LightSnapshot 

Source
#[non_exhaustive]
pub struct LightSnapshot { pub on: bool, pub brightness: u8, pub rendered_brightness: u8, pub color_mode: ColorMode, pub hue: u8, pub saturation: u8, pub enhanced_hue: u16, pub color_x: u16, pub color_y: u16, pub color_temp_mireds: u16, }
Expand description

Complete raw light state handed to LightOutput::state_update after every render pass.

Unlike SceneState (a partial snapshot for Zigbee scene storage, where absent fields mean “don’t touch”), every field here is always present — no Options to unwrap. All values are raw ZCL domains.

#[non_exhaustive]: backends receive this by reference and read its fields, so new state (e.g. a future color-loop phase) can be added without a breaking release. It does mean the struct can’t be constructed with a literal outside this crate — not a use case, since only the state machine produces it.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§on: bool§brightness: u8

Logical level (0-254): the target the light is at or heading to. Stays put during an on/off fade.

§rendered_brightness: u8

The level actually being driven right now (0-254): ramps frame by frame during fades and transitions — key effects off this one to follow what the LED is visibly doing.

§color_mode: ColorMode§hue: u8§saturation: u8§enhanced_hue: u16§color_x: u16§color_y: u16§color_temp_mireds: u16

Trait Implementations§

Source§

impl Clone for LightSnapshot

Source§

fn clone(&self) -> LightSnapshot

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
Source§

impl Copy for LightSnapshot

Source§

impl Debug for LightSnapshot

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for LightSnapshot

Source§

impl PartialEq for LightSnapshot

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for LightSnapshot

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.