Struct Mouse 

pub struct Mouse {
    pub x: u16,
    pub y: u16,
    pub button: MouseButton,
    pub modifiers: KeyModifiers,
}

Mouse-event payload with position, button, and modifier state.

Coordinates are zero-based; (0, 0) is the upper-left corner of the terminal. In normal mouse modes, x and y are cell coordinates. When the application has enabled SGR-Pixel encoding (DEC mode 1016), the same fields contain pixel offsets instead; call mouse_pixel_to_cell if cell coordinates are needed.

Fields

x: u16

Horizontal coordinate.

Interpreted as a column in normal mouse modes and a pixel offset in SGR-Pixel mode.

y: u16

Vertical coordinate.

Interpreted as a row in normal mouse modes and a pixel offset in SGR-Pixel mode.

button: MouseButton

Button, wheel direction, or no-button marker associated with the event.

modifiers: KeyModifiers

Keyboard modifiers that were active when the mouse event was reported.

Implementations

impl Mouse

pub fn new(x: u16, y: u16, button: MouseButton, modifiers: KeyModifiers) -> Self

Construct a mouse payload from decoded coordinates, button, and modifiers.

The constructor stores its arguments unchanged. Pass zero-based cell coordinates for ordinary mouse modes, or zero-based pixel offsets for SGR-Pixel mode. It never allocates or panics.

Trait Implementations

impl Clone for Mouse

fn clone(&self) -> Mouse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mouse

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

Formats the value using the given formatter.

impl Hash for Mouse

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Mouse

fn eq(&self, other: &Mouse) -> 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 Copy for Mouse

impl Eq for Mouse

impl StructuralPartialEq for Mouse