Struct LightSynchronousProxy

pub struct LightSynchronousProxy { /* private fields */ }

Implementations

impl LightSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<LightEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn get_num_lights( &self, ___deadline: MonotonicInstant, ) -> Result<u32, Error>

Returns the total number of physical lights. This will typically be 1 for a simple LED light, but may be greater than one for an array of lights or a more complicated lighting device. The multiple lights are addressed using “index” parameter in the calls below.

pub fn get_num_light_groups( &self, ___deadline: MonotonicInstant, ) -> Result<u32, Error>

Returns the total number of light groups (does not count single lights). The light groups are addressed using “group_id” parameter in the calls below.

pub fn get_info( &self, index: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetInfoResult, Error>

Returns info for the single light. index: Index of the light defined by board. Must be less than value returned by GetNumLights.

pub fn get_current_simple_value( &self, index: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetCurrentSimpleValueResult, Error>

Returns the current value. If the light is ON, the value is True. If the light is OFF, the value is False. If the capability ‘SIMPLE’ is not supported by this light, returns NOT_SUPPORTED. Use GetInfo to check if light supports this operation. index: a number between 0 inclusive and the count received from GetNumLights.

pub fn set_simple_value( &self, index: u32, value: bool, ___deadline: MonotonicInstant, ) -> Result<LightSetSimpleValueResult, Error>

Sets the current value. Value should be set to ‘TRUE’ to turn on the light. Value should be set to ‘FALSE’ to turn off the light. If the capability ‘SIMPLE’ is not supported by this light, returns NOT_SUPPORTED. Use GetInfo to check if light supports this operation. index: a number between 0 inclusive and the count received from GetNumLights.

pub fn get_current_brightness_value( &self, index: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetCurrentBrightnessValueResult, Error>

Returns the current brightness value (0.0 - 1.0) of the light indicated by index, where 0.0 is minimum brightness and 1.0 is maximum. If the capability ‘BRIGHTNESS’ is not supported by this light, returns NOT_SUPPORTED. Use GetInfo to check if light supports this operation. index: a number between 0 inclusive and the count received from GetNumLights.

pub fn set_brightness_value( &self, index: u32, value: f64, ___deadline: MonotonicInstant, ) -> Result<LightSetBrightnessValueResult, Error>

Sets the current brightness value (0.0 - 1.0), where 0.0 is minimum brightness and 1.0 is maximum. If the capability ‘BRIGHTNESS’ is not supported by this light, returns NOT_SUPPORTED. Use GetInfo to check if light supports this operation. index: a number between 0 inclusive and the count received from GetNumLights.

pub fn get_current_rgb_value( &self, index: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetCurrentRgbValueResult, Error>

Returns the current RGB value for the single light. If the capability ‘RGB’ is not supported by this light, returns NOT_SUPPORTED. Use GetInfo to check if light supports this operation. index: a number between 0 inclusive and the count received from GetNumLights.

pub fn set_rgb_value( &self, index: u32, value: &Rgb, ___deadline: MonotonicInstant, ) -> Result<LightSetRgbValueResult, Error>

Sets the current RGB value. If the capability ‘RGB’ is not supported by this light, returns NOT_SUPPORTED. Use GetInfo to check if light supports this operation. index: a number between 0 inclusive and the count received from GetNumLights.

pub fn get_group_info( &self, group_id: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetGroupInfoResult, Error>

Returns group info for the light group. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

pub fn get_group_current_simple_value( &self, group_id: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetGroupCurrentSimpleValueResult, Error>

Returns an array of the current values.If the light is ON, the value is True. If the light is OFF, the value is False. If group_id is invalid, INVALID_INDEX will be returned. If the capability ‘SIMPLE’ is not supported by this group, returns NOT_SUPPORTED. Use GetGroupInfo to check if group supports this operation. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

pub fn set_group_simple_value( &self, group_id: u32, values: &[bool], ___deadline: MonotonicInstant, ) -> Result<LightSetGroupSimpleValueResult, Error>

Sets the current values through the values array. Value should be set to ‘TRUE’ to turn on the light. Value should be set to ‘FALSE’ to turn off the light. If group_id is invalid, INVALID_INDEX will be returned. If the capability ‘SIMPLE’ is not supported by this group, returns NOT_SUPPORTED. Use GetGroupInfo to check if group supports this operation. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

pub fn get_group_current_brightness_value( &self, group_id: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetGroupCurrentBrightnessValueResult, Error>

Returns an array of the current brightness values (0.0 - 1.0) for the light group, where 0.0 is minimum brightness and 1.0 is maximum. If group_id is invalid, INVALID_INDEX will be returned. If the capability ‘BRIGHTNESS’ is not supported by this group, returns NOT_SUPPORTED. Use GetGroupInfo to check if group supports this operation. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

pub fn set_group_brightness_value( &self, group_id: u32, values: &[f64], ___deadline: MonotonicInstant, ) -> Result<LightSetGroupBrightnessValueResult, Error>

Sets the current brightness values (0.0 - 1.0) for the light group through the values array, where 0.0 is minimum brightness and 1.0 is maximum. If group_id is invalid, INVALID_INDEX will be returned. If the capability ‘BRIGHTNESS’ is not supported by this group, returns NOT_SUPPORTED. Use GetGroupInfo to check if group supports this operation. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

pub fn get_group_current_rgb_value( &self, group_id: u32, ___deadline: MonotonicInstant, ) -> Result<LightGetGroupCurrentRgbValueResult, Error>

Returns an array of the current RGB values for the light group. If group_id is invalid, INVALID_INDEX will be returned. If the capability ‘RGB’ is not supported by this group, returns NOT_SUPPORTED. Use GetGroupInfo to check if group supports this operation. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

pub fn set_group_rgb_value( &self, group_id: u32, values: &[Rgb], ___deadline: MonotonicInstant, ) -> Result<LightSetGroupRgbValueResult, Error>

Sets the current RGB value for the light group. If group_id is invalid, INVALID_INDEX will be returned. If the capability ‘RGB’ is not supported by this group, returns NOT_SUPPORTED. Use GetGroupInfo to check if group supports this operation. group_id: a number between 0 inclusive and the count received from GetNumLightGroups.

Trait Implementations

impl Debug for LightSynchronousProxy

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

Formats the value using the given formatter.

impl SynchronousProxy for LightSynchronousProxy

type Proxy = LightProxy

The async proxy for the same protocol.

type Protocol = LightMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.