Struct MouseEvent

pub struct MouseEvent {
    pub timestamp: Option<i64>,
    pub view_parameters: Option<ViewParameters>,
    pub device_info: Option<MouseDeviceInfo>,
    pub pointer_sample: Option<MousePointerSample>,
    pub stream_info: Option<MouseEventStreamInfo>,
    pub trace_flow_id: Option<u64>,
    /* private fields */
}

The self-sufficient, self-consistent collection of pointer-related data, sent from server to client.

Fields

timestamp: Option<i64>

The time this event was observed. Required.

view_parameters: Option<ViewParameters>

The parameters of the associated view and viewport, sufficient to correctly interpret the position, orientation, magnitude, and inter-event distance of pointer events dispatched to a view.

• It is issued on connection and on change.

device_info: Option<MouseDeviceInfo>

A description of the mouse device, sufficient to correctly interpret the capabilities and usage intent of the device.

• It is issued once per device.

pointer_sample: Option<MousePointerSample>

A description of each sampled data point in a mouse event stream.

Issuance policy. There are two dispatch modes, “hover” and “latched”. Hover mode is default, and the stream is dispatched in fragments to the visible client that each mouse event hovers above. Latched mode directs the stream to a single client (regardless of view boundary) until unlatched. Latched mode is typically toggled when the user presses the primary mouse button, but is ultimately a product-specific policy.

stream_info: Option<MouseEventStreamInfo>

The signal for view entry/exit in hover mode.

• It is issued on hover entry into a view, and hover exit from a view.

trace_flow_id: Option<u64>

An identifier to correlate this event’s send/receive occurrence across component boundaries or abstraction layers.

Trait Implementations

impl Clone for MouseEvent

fn clone(&self) -> MouseEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MouseEvent

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

Formats the value using the given formatter.

impl<D: ResourceDialect> Decode<MouseEvent, D> for MouseEvent

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for MouseEvent

fn default() -> MouseEvent

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<MouseEvent, D> for &MouseEvent

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

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

impl PartialEq for MouseEvent

fn eq(&self, other: &MouseEvent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TypeMarker for MouseEvent

type Owned = MouseEvent

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for MouseEvent

type Borrowed<'a> = &'a MouseEvent

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for MouseEvent

impl StructuralPartialEq for MouseEvent