Struct MouseSourceProxy

pub struct MouseSourceProxy { /* private fields */ }

Implementations

impl MouseSourceProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.ui.pointer/MouseSource.

pub fn take_event_stream(&self) -> MouseSourceEventStream

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<Vec<MouseEvent>, DefaultFuchsiaResourceDialect>

A method for a client to receive mouse pointer events.

This call is formulated as a “hanging get” pattern: the client asks for a set of recent events, and receives them via the callback. This pull-based approach ensures that clients consume events at their own pace; events don’t clog up the channel in an unbounded manner.

Flow control. The caller is allowed at most one in-flight |Watch| call at a time; it is a logical error to have concurrent calls to |Watch|. Non-compliance results in channel closure.

Client pacing. The server will dispatch events to the caller on a FIFO, lossless, best-effort basis, but the caller must allocate enough time to keep up with new events.

Event times. The timestamps on each event in the event vector are not guaranteed monotonic; events from different devices may be injected into Scenic at different times. Generally, events from a single device are expected to have monotonically increasing timestamps.

View parameters. Occasionally, changes in view or viewport require notifying the client. If a |MouseEvent| carries |ViewParameters|, these parameters apply to successive |MousePointerSample|s until the next |ViewParameters|.

Trait Implementations

impl Clone for MouseSourceProxy

fn clone(&self) -> MouseSourceProxy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseSourceProxy

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

Formats the value using the given formatter.

impl MouseSourceProxyInterface for MouseSourceProxy

type WatchResponseFut = QueryResponseFut<Vec<MouseEvent>>

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

impl Proxy for MouseSourceProxy

type Protocol = MouseSourceMarker

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.