Struct huelib::resource::light::StateModifier

pub struct StateModifier {
    pub on: Option<bool>,
    pub brightness: Option<Adjust<u8>>,
    pub hue: Option<Adjust<u16>>,
    pub saturation: Option<Adjust<u8>>,
    pub color_space_coordinates: Option<Adjust<(f32, f32)>>,
    pub color_temperature: Option<Adjust<u16>>,
    pub alert: Option<Alert>,
    pub effect: Option<Effect>,
    pub transition_time: Option<u16>,
}

Modifier for the light state.

Fields

on: Option<bool>

Turns the light on or off.

brightness: Option<Adjust<u8>>

Sets the brightness of the light.

hue: Option<Adjust<u16>>

Sets the hue of a light.

saturation: Option<Adjust<u8>>

Sets the saturation of a light.

color_space_coordinates: Option<Adjust<(f32, f32)>>

Sets the color space coordinates of the light.

color_temperature: Option<Adjust<u16>>

Sets the color temperature of a light.

alert: Option<Alert>

Sets the alert effect of a light.

effect: Option<Effect>

Sets the dynamic effect of a light.

transition_time: Option<u16>

Sets the transition duration of state changes.

This is given as a multiple of 100ms.

Implementations

impl StateModifier

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

Sets the on field of this struct.

pub fn with_brightness(self, value: Adjust<u8>) -> Self

Sets the brightness field of this struct.

pub fn with_hue(self, value: Adjust<u16>) -> Self

Sets the hue field of this struct.

pub fn with_saturation(self, value: Adjust<u8>) -> Self

Sets the saturation field of this struct.

pub fn with_color_space_coordinates(self, value: Adjust<(f32, f32)>) -> Self

Sets the color_space_coordinates field of this struct.

pub fn with_color_temperature(self, value: Adjust<u16>) -> Self

Sets the color_temperature field of this struct.

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

Sets the alert field of this struct.

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

Sets the effect field of this struct.

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

Sets the transition_time field of this struct.

impl StateModifier

pub fn new() -> Self

Creates a new StateModifier.

pub fn with_color(self, value: Color) -> Self

Convenient method to set the color_space_coordinates and brightness fields.

Trait Implementations

impl Clone for StateModifier

pub fn clone(&self) -> StateModifier

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StateModifier

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

Formats the value using the given formatter.

impl Default for StateModifier

pub fn default() -> StateModifier

Returns the "default value" for a type.

impl Modifier for StateModifier

type Id = String

The type of the identifier.

pub fn url_suffix(id: Self::Id) -> String

Returns the suffix of the API URL.

pub fn execute(
    &self,
    bridge: &Bridge,
    id: Self::Id
) -> Result<Vec<Response<Modified>>>

Sends the request to modify the resource.

impl PartialEq<StateModifier> for StateModifier

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

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

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

This method tests for !=.

impl Serialize for StateModifier

pub 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