Struct Tui 

pub struct Tui<'s> { /* private fields */ }

The terminal a command’s views draw on, in the command’s session: up from the first view (Tui::run) until dropped, so every view of the command and the work between them (Tui::work) share one screen. While it is up, a data-beans kill asks the views to stop as Ctrl-C does (Tui::stop_requested), and work under way finishes first. Log records raised while it is up are held back and written once the normal screen is back, or as work between views runs.

Implementations

impl<'s> Tui<'s>

pub fn new(session: &'s Session) -> Self

Views of session, the screen not up yet.

pub fn session(&self) -> &'s Session

pub fn stop_requested(&self) -> bool

Whether data-beans kill asked the command to stop: no more views and no more work after the one running.

pub fn run<S: Screen>(&mut self, screen: &mut S) -> Result<()>

Run screen until it is done, its keys to Screen::handle_key.

pub fn run_with<S: Screen>( &mut self, screen: &mut S, on_key: impl FnMut(&mut S, KeyEvent), ) -> Result<()>

Run screen until it is done, each key (but Ctrl-C) handed to on_key. The screen comes up with the first view and stays up after. A stop interrupts the view, as Ctrl-C does. Blocking work (Screen::pending_work) runs on the normal screen, where its own progress output belongs, and the view comes back after it. The mouse and keys held with modifiers are reported only to a screen that asks for them, and events already queued (a turn of the wheel is several) are taken before the screen is drawn again. After an attach the modes are on again and the view is drawn whole.

pub fn work<T>(&mut self, f: impl FnOnce() -> T) -> Result<T>

Run f, the command’s own work before, between or after its views, on the normal screen, its log records written as they come; the screen is taken back after it, to be drawn whole by the next view. A kill meanwhile lets f finish and is then Tui::stop_requested. Before the first view the screen stays down: f runs where it is, a kill waiting for it all the same.

Trait Implementations

impl Drop for Tui<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.