Struct lifxi::http::StateChange

pub struct StateChange {
    pub power: Option<Power>,
    pub duration: Option<Duration>,
    pub infrared: Option<f32>,
    pub hue: Option<i16>,
    pub saturation: Option<f32>,
    pub brightness: Option<f32>,
    pub kelvin: Option<i16>,
}

Encodes a desired state change.

This struct is intended for use with Selected::change_state, and it is encouraged to use the builder methods instead of directly constructing a changeset.

Fields

power: Option<Power>

The desired power state.

duration: Option<Duration>

How long the transition should take.

infrared: Option<f32>

The desired change in infrared light level.

hue: Option<i16>

The desired change in hue.

saturation: Option<f32>

The desired change in saturation.

brightness: Option<f32>

The desired change in brightness.

kelvin: Option<i16>

The desired change in color temperature.

Implementations

impl StateChange

pub fn new() -> Self

Constructs an empty state change.

Identical to StateChange::new.

pub fn builder() -> Self

Creates a new builder.

pub fn power<P: Into<Power>>(self, on: P) -> Self

Builder function to change target power state.

Example

use lifxi::http::StateChange;
let new: StateChange = StateChange::builder().power(true);

pub fn transition<T: Into<Duration>>(self, duration: T) -> Self

Builder function to change transition duration.

Example

use lifxi::http::StateChange;
let new: StateChange = StateChange::builder().transition(::std::time::Duration::from_secs(1));

pub fn hue(self, hue: i16) -> Self

Builder function to set target change in hue.

Example

use lifxi::http::StateChange;
let new: StateChange = StateChange::builder().hue(-60);

pub fn saturation(self, saturation: f32) -> Self

Builder function to set target change in saturation.

Example

use lifxi::http::StateChange;
let new: StateChange = StateChange::builder().saturation(-0.1);

pub fn brightness(self, brightness: f32) -> Self

Builder function to set target change in brightness.

Example

use lifxi::http::StateChange;
let new: StateChange = StateChange::builder().brightness(0.4);

pub fn kelvin(self, temp: i16) -> Self

Builder function to set target change in color temperature.

Example

use lifxi::http::StateChange;
let new: StateChange = StateChange::builder().kelvin(-200);

Trait Implementations

impl<'a, T: Select> AsRequest<StateChange> for ChangeState<'a, T>

fn method() -> Method

The HTTP verb to be used.

fn client(&self) -> &Client

A reference to the shared client (so we can reuse it).

fn path(&self) -> String

The relative path (to the API root) of the appropriate endpoint.

fn body(&self) -> &StateChange

The request body to be used, as configured by the user.

fn attempts(&self) -> NonZeroU8

The number of attempts to be made.

impl Clone for StateChange

fn clone(&self) -> StateChange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for StateChange

fn default() -> StateChange

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StateChange

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

Deserialize this value from the given Serde deserializer.

impl Serialize for StateChange

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

Serialize this value into the given Serde serializer.