Struct LightProxy

pub struct LightProxy { /* private fields */ }

Implementations

impl LightProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.hardware.light/Light.

pub fn take_event_stream(&self) -> LightEventStream

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

Panics

Panics if the event stream was already taken.

pub fn get_num_lights( &self, ) -> QueryResponseFut<u32, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<u32, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetInfoResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetCurrentSimpleValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightSetSimpleValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetCurrentBrightnessValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightSetBrightnessValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetCurrentRgbValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightSetRgbValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetGroupInfoResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetGroupCurrentSimpleValueResult, DefaultFuchsiaResourceDialect>

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], ) -> QueryResponseFut<LightSetGroupSimpleValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetGroupCurrentBrightnessValueResult, DefaultFuchsiaResourceDialect>

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], ) -> QueryResponseFut<LightSetGroupBrightnessValueResult, DefaultFuchsiaResourceDialect>

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, ) -> QueryResponseFut<LightGetGroupCurrentRgbValueResult, DefaultFuchsiaResourceDialect>

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], ) -> QueryResponseFut<LightSetGroupRgbValueResult, DefaultFuchsiaResourceDialect>

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 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 GetNumLightsResponseFut = QueryResponseFut<u32>

type GetNumLightGroupsResponseFut = QueryResponseFut<u32>

type GetInfoResponseFut = QueryResponseFut<Result<Info, LightError>>

type GetCurrentSimpleValueResponseFut = QueryResponseFut<Result<bool, LightError>>

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

type GetCurrentBrightnessValueResponseFut = QueryResponseFut<Result<f64, LightError>>

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

type GetCurrentRgbValueResponseFut = QueryResponseFut<Result<Rgb, LightError>>

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

type GetGroupInfoResponseFut = QueryResponseFut<Result<GroupInfo, LightError>>

type GetGroupCurrentSimpleValueResponseFut = QueryResponseFut<Result<Option<Vec<bool>>, LightError>>

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

type GetGroupCurrentBrightnessValueResponseFut = QueryResponseFut<Result<Option<Vec<f64>>, LightError>>

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

type GetGroupCurrentRgbValueResponseFut = QueryResponseFut<Result<Option<Vec<Rgb>>, LightError>>

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

fn get_num_lights(&self) -> Self::GetNumLightsResponseFut

fn get_num_light_groups(&self) -> Self::GetNumLightGroupsResponseFut

fn get_info(&self, index: u32) -> Self::GetInfoResponseFut

fn get_current_simple_value( &self, index: u32, ) -> Self::GetCurrentSimpleValueResponseFut

fn set_simple_value( &self, index: u32, value: bool, ) -> Self::SetSimpleValueResponseFut

fn get_current_brightness_value( &self, index: u32, ) -> Self::GetCurrentBrightnessValueResponseFut

fn set_brightness_value( &self, index: u32, value: f64, ) -> Self::SetBrightnessValueResponseFut

fn get_current_rgb_value( &self, index: u32, ) -> Self::GetCurrentRgbValueResponseFut

fn set_rgb_value(&self, index: u32, value: &Rgb) -> Self::SetRgbValueResponseFut

fn get_group_info(&self, group_id: u32) -> Self::GetGroupInfoResponseFut

fn get_group_current_simple_value( &self, group_id: u32, ) -> Self::GetGroupCurrentSimpleValueResponseFut

fn set_group_simple_value( &self, group_id: u32, values: &[bool], ) -> Self::SetGroupSimpleValueResponseFut

fn get_group_current_brightness_value( &self, group_id: u32, ) -> Self::GetGroupCurrentBrightnessValueResponseFut

fn set_group_brightness_value( &self, group_id: u32, values: &[f64], ) -> Self::SetGroupBrightnessValueResponseFut

fn get_group_current_rgb_value( &self, group_id: u32, ) -> Self::GetGroupCurrentRgbValueResponseFut

fn set_group_rgb_value( &self, group_id: u32, values: &[Rgb], ) -> Self::SetGroupRgbValueResponseFut

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 into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

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