Client

Struct Client 

Source
pub struct Client { /* private fields */ }
Expand description

The crux of the HTTP API. Start here.

The client is the entry point for the web API interface. First construct a client, then use it to perform whatever tasks necessary.

§Example

use lifxi::http::prelude::*;
let client = Client::new("foo");
let result = client
    .select(Selector::All)
    .set_state()
    .color(Color::Red)
    .power(true)
    .retry()
    .send();

Implementations§

Source§

impl Client

Source

pub fn new<S: ToString>(token: S) -> Self

Constructs a new Client with the given access token.

§Examples
use lifxi::http::prelude::*;
let secret = "foo";
let client = Client::new(secret);
let secret = "foo".to_string();
let client = Client::new(secret);
Source

pub fn select<T: Select>(&self, selector: T) -> Selected<'_, T>

Specifies the lights upon which to act.

See the documentation for Selected<T> to understand why this is useful.

Source

pub fn set_states(&self) -> SetStates<'_>

Creates a request to set multiple states (on multiple lights).

For a simpler API when working with a single state on one or multiple lights, see Selected::set_state.

Source

pub fn validate(&self, color: &Color) -> Request<'_, ()>

Creates a request to validate the given color.

§Example
use lifxi::http::prelude::*;
let secret = "foo";
let client = Client::new(secret);
let color = Color::Custom("cyan".to_string());
let is_valid = client
    .validate(&color)
    .send()
    .is_ok();
Source

pub fn scenes(&self) -> Scenes<'_>

Entry point for working with scenes.

See Scenes.

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.
Source§

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

Source§

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

Source§

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,