Struct Tui 

pub struct Tui<T, R: Runtime = CrosstermRuntime> { /* private fields */ }

TUI application entry points. Direct typed TUI execution for a derive-based clap parser.

Tui::<T>::run() is the primary explicit integration surface for applications that define their own Command::Tui dispatch branch and want the selected command value back as T.

Implementations

impl<T> Tui<T, CrosstermRuntime>

where T: Parser + CommandFactory,

pub fn new() -> Self

Create a typed app from a derive-based parser.

Examples found in repository

examples/showcase.rs (line 142)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

examples/simple.rs (line 46)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

examples/subcommands.rs (line 42)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

impl<T, R: Runtime> Tui<T, R>

where T: Parser + CommandFactory,

pub fn hide_entrypoint(self, name: impl Into<String>) -> Result<Self, TuiError>

Hide a matching top-level entrypoint subcommand from the rendered TUI.

This only changes the command tree used to build the TUI. Typed reparsing after submit still uses the original clap parser type T.

Errors

Returns TuiError::UnknownEntrypoint when name does not match a canonical top-level subcommand name on the render command.

Examples found in repository

examples/showcase.rs (line 142)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

examples/simple.rs (line 46)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

examples/subcommands.rs (line 42)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

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

Apply configuration before the TUI starts.

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

Replace the default runtime.

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

Run the TUI and parse the submitted command into the bound parser type.

Returns Ok(Some(parsed)) when the user submits a valid command and Ok(None) when the user exits without submitting. If clap reparsing produces help, version, or parse-display behavior, this method returns Err(TuiError::Clap(_)) without printing automatically or calling std::process::exit.

Errors

Returns an error when terminal setup, rendering, runtime integration, or clap reparsing fails.

Examples found in repository

examples/showcase.rs (line 142)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

examples/simple.rs (line 46)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

examples/subcommands.rs (line 42)

fn main() -> Result<(), clap_tui::TuiError> {
    match Command::parse() {
        Command::Tui => {
            if let Some(command) = Tui::<Command>::new().hide_entrypoint("tui")?.run()? {
                dispatch(command);
            }
        }
        command => dispatch(command),
    }

    Ok(())
}

pub fn into_untyped(self) -> TuiApp<R>

Drop down to the untyped app surface when only argv or ArgMatches execution is needed.

Trait Implementations

impl<T> Default for Tui<T, CrosstermRuntime>

where T: Parser + CommandFactory,

fn default() -> Self

Returns the “default value” for a type.