rite-tui 0.4.1

Interactive terminal frontend for Rite ceremonies (internal to the `rite` CLI; no stable API)
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

//! `Msg` and `Cmd`, the inputs and outputs of `update`.

use crossterm::event::{KeyEvent, MouseEvent};
use rite_runtime::{ExecEvent, UiCommand};

/// Input to the pure [`update`] function.
///
/// Every state transition in the UI corresponds to exactly one `Msg`,
/// which makes the audit surface a single enum.
///
/// [`update`]: crate::update::update
#[derive(Debug)]
pub enum Msg {
    /// Key press from the terminal.
    Key(KeyEvent),
    /// Mouse event from the terminal (currently unused, reserved).
    Mouse(MouseEvent),
    /// Terminal resize.
    Resize {
        /// New width in cells.
        cols: u16,
        /// New height in cells.
        rows: u16,
    },
    /// Timer tick for spinners and time-driven redraws.
    Tick,
    /// Event from the runtime executor.
    Exec(ExecEvent),
    /// Explicit quit signal.
    Quit,
}

/// Side effect produced by [`update`]. The runtime loop interprets these
/// after every `update` call.
///
/// [`update`]: crate::update::update
#[derive(Debug)]
pub enum Cmd {
    /// Send a command back to the executor thread.
    SendCommand(UiCommand),
    /// Stop the loop.
    Quit,
}