Skip to main content

Crate foundry_tui

Crate foundry_tui 

Source
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ยง

TerminalGuard
Handles terminal setup and teardown for interactive TUIs.
TuiEnvironment
Runtime environment details used to decide whether a TUI can run interactively.

Enumsยง

TuiFallbackReason
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ยง

CrosstermTerminal
The default terminal backend used by Foundry TUIs.
PanicHandler ๐Ÿ”’