Expand description
Shared terminal UI utilities for Foundry.
Re-exportsยง
pub(crate) use DisableMouseCapture;๐pub(crate) use EnableMouseCapture;๐pub(crate) use Event;๐pub(crate) use read;๐pub(crate) use execute;๐pub(crate) use EnterAlternateScreen;๐pub(crate) use LeaveAlternateScreen;๐pub(crate) use disable_raw_mode;๐pub(crate) use enable_raw_mode;๐pub(crate) use Frame;๐pub(crate) use Terminal;๐pub(crate) use Backend;๐pub(crate) use CrosstermBackend;๐pub(crate) use env;๐pub(crate) use env;๐pub(crate) use IsTerminal;๐pub(crate) use Result as IoResult;๐pub(crate) use Stdout;๐pub(crate) use Write;๐pub(crate) use stdin;๐pub(crate) use stdout;๐pub(crate) use ops::ControlFlow;๐pub(crate) use PanicHookInfo;๐pub(crate) use set_hook;๐pub(crate) use take_hook;๐pub(crate) use sync::Arc;๐pub(crate) use thread::panicking;๐
Structsยง
- Terminal
Guard - Handles terminal setup and teardown for interactive TUIs.
- TuiEnvironment
- Runtime environment details used to decide whether a TUI can run interactively.
Enumsยง
- TuiFallback
Reason - Why an interactive TUI should not be opened.
- TuiMode
- The resolved mode for a requested TUI run.
Traitsยง
- TuiApp
- An interactive terminal application.
Functionsยง
- run_app
- Runs an interactive terminal application with the default Foundry terminal setup.
- run_
app_ if_ interactive - Runs an app only when the current environment supports an interactive TUI.
- run_
app_ ๐inner - tui_
mode - Detects whether a requested TUI should run interactively or fall back to line output.
- with_
terminal - Runs a closure with the default Foundry terminal setup.
Type Aliasesยง
- Crossterm
Terminal - The default terminal backend used by Foundry TUIs.
- Panic
Handler ๐