Skip to content

vox-term API Reference (generated)

Crate: vox-term · Version: 0.6.0 · Target: Library (lib.rs)

Headless-capable ratatui TUI front-end for vox-terminal-core.

vox-term — headless-capable ratatui TUI for vox-terminal-core. Re-exported so integration tests (tests/) can access modules.

DependencyKind
vox-terminal-coreNormal
ModuleDescription
app—
term_setup—
theme—
vt—
ui—
blocks—
input—
palette—
Dependency Topology, diagram 13 nodes, 2 edges: vox-term → vox-terminal-core; vox-cli → vox-termvox-termvox-terminal-corevox-cli
Diagram source
graph {
direction: right
node vox_term: "vox-term"
node vox_terminal_core: "vox-terminal-core"
vox_term -> vox_terminal_core
node vox_cli: "vox-cli"
vox_cli -> vox_term
}
Consumer CrateRole
vox-cliDirect workspace dependent
KindSymbolSignatureSourceDescription
structapp::TermCliArgspub struct TermCliArgscrates/vox-term/src/app.rs#L35-L38Parsed CLI flags for vox-term (--attach <session_id>, --local).
fnapp::parse_iterpub fn parse_iter<I, S>(args: I) -> Selfcrates/vox-term/src/app.rs#L41—
fnapp::from_envpub fn from_env() -> Selfcrates/vox-term/src/app.rs#L65-L67—
fnapp::resolve_hostpub async fn resolve_host(force_local: bool) -> std::sync::Arc<dyn SessionHost>crates/vox-term/src/app.rs#L72-L74Resolve the active [SessionHost]: connects to vox-orchestrator-d when reachable (unless force_local is true) and falls back to an in-process LocalHost.
fnapp::runpub fn run() -> Result<()>crates/vox-term/src/app.rs#L103-L213Entry-point for the TUI. Headless-safe: degrades to plain stdout under TERM=dumb. Per-keystroke dispatch logic (InputBox::submit -> Session::submit) is covered by crates/vox-term/tests/dispatch.rs and the session::tests module; this loop itself is an interactive event loop over a real terminal and isn’t unit-testable. See contracts/toestub/suppressions.v1.json.
structterm_setup::TermSetuppub struct TermSetupcrates/vox-term/src/term_setup.rs#L15-L17RAII guard: enters raw mode + alternate screen; restores both on drop.
fnterm_setup::newpub fn new() -> anyhow::Result<Self>crates/vox-term/src/term_setup.rs#L24-L28Enter raw mode and the alternate screen. Returns Err if the terminal does not support raw mode (e.g. TERM=dumb, pipe, CI). Callers should degrade gracefully.
fntheme::is_dumb_terminalpub fn is_dumb_terminal() -> boolcrates/vox-term/src/theme.rs#L25-L27Returns true when the terminal is known-dumb (no color/glyph support).
fntheme::prompt_glyphpub fn prompt_glyph() -> &'static strcrates/vox-term/src/theme.rs#L30-L36Prompt glyph — ASCII fallback under dumb terminals.
structvt::VtGridpub struct VtGridcrates/vox-term/src/vt.rs#L48-L53A VT100/VT220 terminal grid backed by alacritty_terminal.
fnvt::newpub fn new(cols: u16, rows: u16) -> Selfcrates/vox-term/src/vt.rs#L56-L68—
fnvt::feedpub fn feed(&mut self, bytes: &[u8])crates/vox-term/src/vt.rs#L71-L73Feed raw bytes (PTY output) into the VT grid.
fnvt::resizepub fn resize(&mut self, cols: u16, rows: u16)crates/vox-term/src/vt.rs#L76-L84Resize the grid.
fnvt::render_linespub fn render_lines(&self) -> Vec<RLine<'static>>crates/vox-term/src/vt.rs#L87-L117Project the visible screen into ratatui Lines with styled Spans.