Struct fidl_fuchsia_settings::LightProxy

pub struct LightProxy { /* private fields */ }

Implementations

impl LightProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for Light

pub fn take_event_stream(&self) -> LightEventStream

Get a Stream of events from the remote end of the Light protocol

Panics

Panics if the event stream was already taken.

pub fn watch_light_groups(&self) -> QueryResponseFut<Vec<LightGroup>>

Fetches information on the controllable light groups on the device. Returns immediately on first call; subsequent calls return when the value changes.

If this call fails, it is considered a fatal error and the channel will be closed.

pub fn watch_light_group(&self, name: &str) -> QueryResponseFut<LightGroup>

Fetches information on an individual light group on the device with the given name. Returns immediately on first call; subsequent calls return when the value changes.

If this call fails, it is considered a fatal error and the channel will be closed. If the failure is due to an invalid light group name, the channel will be closed with a NOT_FOUND epitaph.

pub fn set_light_group_values( &self, name: &str, state: &mut dyn ExactSizeIterator<Item = LightState> ) -> QueryResponseFut<LightSetLightGroupValuesResult>

Sets the values for the lights in the group with the given name.

If the provided value does not match the light group’s type, this call will fail.

The requested changes may not take immediate effect if the light is forced to a certain state by the device’s hardware. This call will still succeed, but the light’s value may not change.

Trait Implementations

impl Clone for LightProxy

fn clone(&self) -> LightProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LightProxy

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

Formats the value using the given formatter.

impl LightProxyInterface for LightProxy

type WatchLightGroupsResponseFut = QueryResponseFut<Vec<LightGroup, Global>>

fn watch_light_groups(&self) -> Self::WatchLightGroupsResponseFut

type WatchLightGroupResponseFut = QueryResponseFut<LightGroup>

fn watch_light_group(&self, name: &str) -> Self::WatchLightGroupResponseFut

type SetLightGroupValuesResponseFut = QueryResponseFut<Result<(), LightError>>

fn set_light_group_values( &self, name: &str, state: &mut dyn ExactSizeIterator<Item = LightState> ) -> Self::SetLightGroupValuesResponseFut

impl Proxy for LightProxy

type Protocol = LightMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed<'a>(&'a self) -> OnSignals<'a>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.