Struct lifxi::http::State

pub struct State {
    pub power: Option<Power>,
    pub color: Option<Color>,
    pub brightness: Option<f32>,
    pub duration: Option<Duration>,
    pub infrared: Option<f32>,
}

Encodes a desired final state.

This struct should only be used directly when using Selected::set_states, and even then, it is encouraged to use the builder methods instead of directly constructing a set of changes.

Fields

power: Option<Power>

The desired power state, if appropriate.

color: Option<Color>

The desired color setting, if appropriate.

brightness: Option<f32>

The desired brightness level (0–1), if appropriate. Will take priority over any brightness specified in a color setting.

duration: Option<Duration>

How long the transition should take.

infrared: Option<f32>

If appropriate, the desired infrared light level (0–1).

Implementations

impl State

pub fn new() -> Self

Constructs an empty state.

Identical to State::builder.

pub fn builder() -> Self

Creates a new builder.

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

Builder function to set target power setting.

Example

use std::time::Duration;
use lifxi::http::State;
let new: State = State::builder().power(true).transition(Duration::from_millis(800));

pub fn color(self, color: Color) -> Self

Builder function to set target color setting.

Example

use std::time::Duration;
use lifxi::http::{Color::*, State};
let new: State = State::builder().color(Red);

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

Builder function to set target brightness setting.

Example

use std::time::Duration;
use lifxi::http::State;
let new: State = State::builder().brightness(0.7).transition(Duration::from_millis(800));

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

Builder function to set animation duration.

Example

use std::time::Duration;
use lifxi::http::{Color::*, State};
let new: State = State::builder().color(Red).transition(Duration::from_millis(800));

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

Builder function to set target maximum infrared level.

Example

use lifxi::http::State;
let new: State = State::builder().infrared(0.8);

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for State

fn default() -> State

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for State

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

Deserialize this value from the given Serde deserializer.

impl Serialize for State

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

Serialize this value into the given Serde serializer.