Struct fidl_fuchsia_settings::InputProxy

pub struct InputProxy { /* private fields */ }

Implementations

impl InputProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.settings/Input.

pub fn take_event_stream(&self) -> InputEventStream

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

Panics

Panics if the event stream was already taken.

pub fn watch( &self, ) -> QueryResponseFut<InputSettings, DefaultFuchsiaResourceDialect>

Gets the current |InputSettings|. Returns immediately on first call; subsequent calls return when the value changes.

When any of the input devices’ states change, this will return the full InputSettings object, containing the states for all the available input devices on the target device.

To find the state of a specific input device, the devices vector contained in settings can be iterated through to find a specific DeviceType. If there are multiple devices of the same DeviceType, the InputDevice’s device_name can be examined in conjunction with the DeviceType to find the desired input device. Together, the device_name and DeviceType uniquely identify an InputDevice.

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

pub fn set( &self, input_states: &[InputState], ) -> QueryResponseFut<InputSetResult, DefaultFuchsiaResourceDialect>

Requests software input devices to set their software state. May not necessarily change the overall state of the device, depending on the hardware state. Will modify the software state of the existing device if a known device_name and device_type are passed. Otherwise it will add a new input device. Devices not included in input_states will not be modified.

Trait Implementations

impl Clone for InputProxy

fn clone(&self) -> InputProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputProxy

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

Formats the value using the given formatter.

impl InputProxyInterface for InputProxy

type WatchResponseFut = QueryResponseFut<InputSettings>

fn watch(&self) -> Self::WatchResponseFut

type SetResponseFut = QueryResponseFut<Result<(), Error>>

fn set(&self, input_states: &[InputState]) -> Self::SetResponseFut

impl Proxy for InputProxy

type Protocol = InputMarker

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.