Struct termimad::TimedEvent

pub struct TimedEvent {
    pub time: Instant,
    pub event: Event,
    pub double_click: bool,
    pub key_combination: Option<KeyCombination>,
}

A user event based on a crossterm event, decorated

• with time
• with a double_click flag
• with a KeyCombination, if the event is a key ending a combination (which may be a simple key)

You normally don’t build this yourself, but rather use the [EventSource].

Fields

time: Instant

event: Event

double_click: bool

false unless you set it yourself using the time or you get the timed event with an EventSource which computes it. Can be true only for left mouse down and left mouse up (both down and up of the second click have it true)

key_combination: Option<KeyCombination>

If you’re interested in key combinations, you should prefer this field over the Key variant of the event field. If you want to react on Press or Repeat, then the event field holds the information.

Implementations

impl TimedEvent

pub fn new(event: Event) -> Self

Wrap a crossterm event into a timed one, with time.

You should normally not need to use this function, but rather obtain the timed event from an EventSource which build the normalized key combination, and sets the double_click flag.

pub fn as_click(&self) -> Option<(u16, u16)>

If it’s a simple mouse up and not determined to be the second click of a double click, return the coordinates

pub fn is_key<K: Into<KeyCombination>>(&self, key: K) -> bool

Trait Implementations

impl Clone for TimedEvent

fn clone(&self) -> TimedEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimedEvent

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

Formats the value using the given formatter.

impl PartialEq for TimedEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for TimedEvent

impl StructuralPartialEq for TimedEvent