Struct MouseModes 

pub struct MouseModes(/* private fields */);

The set of mouse tracking modes an application has enabled and not yet disabled — what it asked for, as distinct from the one protocol the terminal reports in, which is Screen::mouse_mode.

A terminal reports mouse events in exactly one protocol, so the four tracking modes collapse into one value on the input path: enabling ?1003 after ?1002 upgrades the reports, disabling either turns them off. But an application enables them as a set — crossterm’s EnableMouseCapture sends ?1000, ?1002 and ?1003 together — and “did it ask for any-motion tracking, or only button-motion?” is a question about that set. Whether hovering does anything at all hangs on it, and a regression from ?1003 to ?1002 passes every test that only reads the collapsed value while the last mode sent stays the same.

Read it from a snapshot via Screen::mouse_modes:

use termlens::MouseMode;
t.wait_until(|s| s.mouse_modes().contains(MouseMode::AnyMotion))?;

Implementations

impl MouseModes

pub fn contains(self, mode: MouseMode) -> bool

Whether the application currently has mode enabled.

MouseMode::None is not a tracking mode; asking for it answers whether the set is empty, so contains(MouseMode::None) reads as “the application asked for no tracking at all”.

pub fn is_empty(self) -> bool

True while no tracking mode is enabled.

pub fn len(self) -> usize

How many tracking modes are enabled.

pub fn iter(self) -> impl Iterator<Item = MouseMode>

The enabled modes, in the order of the private modes that enable them (?9, ?1000, ?1002, ?1003).

Trait Implementations

impl Clone for MouseModes

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MouseModes

impl Debug for MouseModes

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

Formats the value using the given formatter.

impl Default for MouseModes

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MouseModes

Available on crate feature serde only.

Only the four tracking modes, whatever the file says (#582). The derive took any byte, and a stray bit made len() count a mode iter() never yields: 8 against 4 for 255. No termlens wrote one — the tracker sets exactly those four bits — so masking drops nothing a writer recorded, and unlike a refusal it still reads a file whose writer knew a fifth.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for MouseModes

impl Hash for MouseModes

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 MouseModes

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MouseModes

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MouseModes