alf_tui 0.5.0

A smolderingly-nimble Rust TUI to rediscover your custom shell.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

//! Event handling for the TUI.

use anyhow::Result;
use crossterm::event::{self, Event as CrosstermEvent, KeyEvent};
use std::time::Duration;

/// Application events
#[derive(Debug, Clone)]
pub enum Event {
   /// Keyboard input event
   Key(KeyEvent),
   /// Terminal resize event
   Resize(u16, u16),
   /// Periodic tick for updates
   Tick,
}

/// Event handler for polling terminal events
pub struct EventHandler {
   tick_rate: Duration,
}

impl EventHandler {
   /// Create a new event handler with the given tick rate
   pub fn new(tick_rate: Duration) -> Self {
      Self {
         tick_rate,
      }
   }

   /// Poll for the next event.
   ///
   /// Blocks until either a terminal event occurs or the tick rate elapses.
   /// Returns `Event::Tick` on timeout, or the appropriate event variant.
   pub fn next(&self) -> Result<Event> {
      if event::poll(self.tick_rate)? {
         match event::read()? {
            CrosstermEvent::Key(key) => Ok(Event::Key(key)),
            CrosstermEvent::Resize(w, h) => Ok(Event::Resize(w, h)),
            // Ignore mouse, focus, and paste events
            _ => Ok(Event::Tick),
         }
      } else {
         Ok(Event::Tick)
      }
   }
}