pub struct LightProxy { /* private fields */ }

Implementations§

source§

impl LightProxy

source

pub fn new(channel: AsyncChannel) -> Self

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

source

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.

source

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

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.

source

pub fn get_num_light_groups(&self) -> QueryResponseFut<u32>

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.

source

pub fn get_info(&self, index: u32) -> QueryResponseFut<LightGetInfoResult>

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

source

pub fn get_current_simple_value( &self, index: u32 ) -> QueryResponseFut<LightGetCurrentSimpleValueResult>

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.

source

pub fn set_simple_value( &self, index: u32, value: bool ) -> QueryResponseFut<LightSetSimpleValueResult>

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.

source

pub fn get_current_brightness_value( &self, index: u32 ) -> QueryResponseFut<LightGetCurrentBrightnessValueResult>

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.

source

pub fn set_brightness_value( &self, index: u32, value: f64 ) -> QueryResponseFut<LightSetBrightnessValueResult>

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.

source

pub fn get_current_rgb_value( &self, index: u32 ) -> QueryResponseFut<LightGetCurrentRgbValueResult>

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.

source

pub fn set_rgb_value( &self, index: u32, value: &Rgb ) -> QueryResponseFut<LightSetRgbValueResult>

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.

source

pub fn get_group_info( &self, group_id: u32 ) -> QueryResponseFut<LightGetGroupInfoResult>

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

source

pub fn get_group_current_simple_value( &self, group_id: u32 ) -> QueryResponseFut<LightGetGroupCurrentSimpleValueResult>

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.

source

pub fn set_group_simple_value( &self, group_id: u32, values: &[bool] ) -> QueryResponseFut<LightSetGroupSimpleValueResult>

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.

source

pub fn get_group_current_brightness_value( &self, group_id: u32 ) -> QueryResponseFut<LightGetGroupCurrentBrightnessValueResult>

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.

source

pub fn set_group_brightness_value( &self, group_id: u32, values: &[f64] ) -> QueryResponseFut<LightSetGroupBrightnessValueResult>

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.

source

pub fn get_group_current_rgb_value( &self, group_id: u32 ) -> QueryResponseFut<LightGetGroupCurrentRgbValueResult>

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.

source

pub fn set_group_rgb_value( &self, group_id: u32, values: &[Rgb] ) -> QueryResponseFut<LightSetGroupRgbValueResult>

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§

source§

impl Clone for LightProxy

source§

fn clone(&self) -> LightProxy

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for LightProxy

source§

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

Formats the value using the given formatter. Read more
source§

impl LightProxyInterface for LightProxy

§

type GetNumLightsResponseFut = QueryResponseFut<u32>

source§

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

§

type GetNumLightGroupsResponseFut = QueryResponseFut<u32>

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

§

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

source§

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

source§

impl Proxy for LightProxy

§

type Protocol = LightMarker

The protocol which this Proxy controls.
source§

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.
source§

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

Attempt to convert the proxy back into a channel. Read more
source§

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel. Read more
§

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end. Read more
§

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.
§

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

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

Auto Trait Implementations§

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
§

impl<T> Encode<Ambiguous1> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<T> Encode<Ambiguous2> for T

§

unsafe fn encode( self, _encoder: &mut Encoder<'_>, _offset: usize, _depth: Depth ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more