oino-tui 1.0.0

Oino interactive terminal client over oino-client
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
48
49
50

//! `oino-tui`: the interactive terminal client over
//! [`oino_client::SessionBackend`].
//!
//! The binary constructs the backend (in-process or remote) and a [`TuiHost`] and calls
//! [`run`]. Everything visible is driven by [`App`], a pure state machine over key presses,
//! client events and command replies; [`render::draw`] paints it with ratatui. Extension UI
//! (dialogs, widgets, status, frames, panels, OUS specs) is rendered natively from the
//! frontend-agnostic protocol (ui-protocol.md).
//!
//! # API map
//!
//! | Module | Contents |
//! |---|---|
//! | [`app`] | [`App`], [`AppEvent`], [`Effect`], [`TuiOptions`] |
//! | [`render`] | [`render::draw`] |
//! | [`host`] | [`TuiHost`], [`host::LocalHost`] |
//! | [`input`] | crossterm → [`oino_view::keys::KeyId`] |
//! | [`theme`] | [`theme::Theme`] |
//! | `runner` | `TUI.start` | terminal lifecycle, event loop, effect execution |

#![forbid(unsafe_code)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::panic,
        reason = "tests assert by unwrapping"
    )
)]

pub mod app;
pub mod host;
pub mod input;
pub mod render;
mod runner;
pub mod theme;

pub use app::{App, AppEvent, Effect, Tag, TuiMode, TuiOptions};
pub use host::TuiHost;
pub use runner::run;

/// Failure of the interactive client.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum TuiError {
    /// Terminal I/O failed.
    #[error("terminal: {0}")]
    Io(#[from] std::io::Error),
}