Enum TuiError 

#[non_exhaustive]
pub enum TuiError {
    Terminal(Error),
    Clap(Error),
    Runner(Box<dyn Error + Send + Sync>),
    Cancelled,
    UnknownEntrypoint {
        name: String,
        candidates: Vec<String>,
    },
}

Error type returned by public clap-tui operations. Errors returned by clap-tui.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Terminal(Error)

Terminal IO error.

Clap(Error)

Clap validation error.

Runner(Box<dyn Error + Send + Sync>)

Application callback error.

Cancelled

Lower-level TUI flow exited without running.

Higher-level entry points such as TuiApp::run, Tui::run, and run_with_matches normalize this into Ok(None) or let callers decide what cancellation means.

UnknownEntrypoint

Requested entrypoint subcommand does not exist on the top-level render command.

Fields

name: String

Requested canonical top-level subcommand name.

candidates: Vec<String>

Available canonical top-level subcommand names in declaration order.

Trait Implementations

impl Debug for TuiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for TuiError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for TuiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for TuiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TuiError

fn from(source: Error) -> Self

Converts to this type from the input type.