Struct huelib::light::StateModifier

pub struct StateModifier { /* fields omitted */ }

Modifier for a light.

Methods

impl StateModifier

pub fn new() -> Self

Creates a new state modifier.

pub fn is_empty(&self) -> bool

Whether all attributes are None.

pub fn on(self, value: bool) -> Self

Turns the light on or off.

pub fn brightness(self, modifier_type: ModifierType, value: u8) -> Self

Sets the brightness of the light.

pub fn hue(self, modifier_type: ModifierType, value: u16) -> Self

Sets the hue of a light.

pub fn saturation(self, modifier_type: ModifierType, value: u8) -> Self

Sets the saturation of a light.

pub fn color_space_coordinates(
    self,
    modifier_type: CoordinateModifierType,
    value: (f32, f32)
) -> Self

Sets the x and y coordinates in the color space to set the color of a light.

If the modifier type is Override, the values must be between 0 and 1. If the modifier type is not Override, the values must be between 0 and 0.5.

pub fn color_temperature(self, modifier_type: ModifierType, value: u16) -> Self

Sets the color temperature of a light.

pub fn alert(self, value: Alert) -> Self

Sets the alert effect of a light.

pub fn effect(self, value: Effect) -> Self

Sets the dynamic effect of a light.

pub fn transition_time(self, value: u16) -> Self

Sets the duration of the transition from the light's current state to the new state. This is given as a multiple of 100ms.

Trait Implementations

impl Clone for StateModifier

fn clone(&self) -> StateModifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for StateModifier

impl Debug for StateModifier

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

Formats the value using the given formatter.

impl Default for StateModifier

fn default() -> StateModifier

Returns the "default value" for a type.

impl PartialEq<StateModifier> for StateModifier

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for StateModifier

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StateModifier