Struct TuiApp 

pub struct TuiApp<R: Runtime = CrosstermRuntime> { /* private fields */ }

TUI application entry points. Build and run a TUI from a hand-built clap::Command.

Use crate::Tui for derive-based CLIs that want typed results. Use TuiApp when you are already building a clap::Command by hand, or when you want the untyped surface that returns argv or ArgMatches.

Implementations

impl TuiApp<CrosstermRuntime>

pub fn from_command(command: Command) -> Self

Create a TUI from a hand-built clap::Command.

Examples found in repository

examples/clap_features.rs (line 351)

fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let app = TuiApp::from_command(build_command());
    app.run_with_matches::<_, std::io::Error>(|matches| {
        println!("{matches:#?}");
        Ok(())
    })?;
    Ok(())
}

impl<R: Runtime> TuiApp<R>

pub fn with_config(self, config: TuiConfig) -> Self

Apply configuration before the TUI starts.

pub fn with_runtime<NR: Runtime>(self, runtime: NR) -> TuiApp<NR>

Replace the default runtime.

pub fn run(self) -> Result<Option<Vec<OsString>>, TuiError>

Run the TUI and return the selected canonical argv.

The returned argv is the executable token sequence. Preview and clipboard text are rendered separately from these tokens, using POSIX shell quoting on Unix platforms and PowerShell quoting on Windows.

Returns Ok(Some(argv)) when the user runs a valid command and Ok(None) when the user exits without running. Validation stays inside the TUI flow, so invalid form state is surfaced in-app rather than returned as a clap error from this method.

Errors

Returns an error when terminal setup or event handling fails.

pub fn run_with_matches<F, E>(self, runner: F) -> Result<(), TuiError>

where F: FnOnce(ArgMatches) -> Result<(), E>, E: StdError + Send + Sync + 'static,

Run the TUI and execute a custom handler with ArgMatches.

Returns Ok(()) when the user exits without running. When the user does run, this method reparses the selected argv with the original clap::Command before calling the handler.

Errors

Returns an error when terminal setup or event handling fails, when reparsing the selected argv with clap fails, or when the runner callback fails.

Examples found in repository

examples/clap_features.rs (lines 352-355)

fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let app = TuiApp::from_command(build_command());
    app.run_with_matches::<_, std::io::Error>(|matches| {
        println!("{matches:#?}");
        Ok(())
    })?;
    Ok(())
}