Skip to main content

Module tui

Module tui 

Source
Expand description

Experimental terminal (TUI) backend support.

The renderer lives in the standalone water-rs/tui repository — the CLI only generates a thin launcher crate under the project’s managed build cache and hands the invoking terminal to the built binary. The backend is opt-in through water run --tui alone: it is not a managed crate::backend::Backend, does not appear in backend selection, and cannot be configured in Water.toml while experimental.

Dependency resolution for the generated launcher follows the project’s own framework mode: a waterui_path checkout supplies path dependencies and the checkout’s [patch] table, a channel supplies the resolved framework’s [patch] table, and a stable project resolves everything from the registry. The waterui-tui crate itself comes from WATERUI_TUI_PATH, a water-rs/tui checkout beside a local waterui_path, or the pinned crate::build_info::TUI_BACKEND revision, in that order.

Functions§

build
Build the launcher binary for the host and return its path.
ensure_launcher
Regenerate the launcher crate when it is missing or stale and return its directory.
exec
Hand the invoking terminal to the built launcher.