ratflow 0.2.0

A minimalistic framework for building TUI applications using a reactive architecture.
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

#![doc = include_str!("../README.md")]

use ratatui::Terminal;
use ratatui::prelude::Backend;
use std::io::Error;
use tokio::task::LocalSet;

mod events;
mod on_drop;
mod render;
mod timer;
mod traits;

pub use events::*;
pub use timer::*;

pub use render::Runtime;
pub use traits::{Component, Render};

use crate::render::render_loop;

#[inline]
pub async fn run_with_terminal<
    B: Backend<Error = Error> + 'static,
    F: Render + 'static,
    C: Component<F>,
>(
    app: C,
    terminal: &mut Terminal<B>,
) -> Result<(), Error> {
    let _ = any_spawner::Executor::init_tokio();
    LocalSet::new().run_until(render_loop(app, terminal)).await
}

#[inline]
pub async fn run<F: Render + 'static, C: Component<F>>(app: C) -> Result<(), Error> {
    let mut terminal = ratatui::init();
    let res = run_with_terminal(app, &mut terminal).await;
    ratatui::restore();
    res
}