Enum CliError 

pub enum CliError {
    InvalidArgument(String),
    InvalidPath {
        path: String,
        reason: String,
    },
    CommandFailed {
        command: String,
        reason: String,
    },
    TuiError(String),
    IoWithPath {
        message: String,
        path: PathBuf,
    },
    Io(Error),
    DangerousCwd {
        path: PathBuf,
        hint: String,
    },
}

Errors originating from CLI commands and TUI.

Variants

InvalidArgument(String)

A command received invalid arguments.

InvalidPath

The specified path does not exist or is not a directory.

Fields

path: String

The path that was invalid.

reason: String

Why the path is invalid.

CommandFailed

A subcommand failed.

Fields

command: String

Which command failed.

reason: String

Why it failed.

TuiError(String)

TUI rendering error.

IoWithPath

IO error with path context.

Fields

message: String

Human-readable description of the operation that failed.

path: PathBuf

The file or directory involved.

Io(Error)

IO error.

DangerousCwd

serve was invoked from a path on the dangerous-cwd denylist with no nearby git repository (e.g. $HOME, /, or a drive root). Auto-scan is refused because recursive watching from such a location can consume tens of GB of memory.

Fields

path: PathBuf

The offending cwd that triggered the refusal.

hint: String

Multi-line, user-facing suggestions for how to proceed.

Implementations

impl CliError

pub fn scan(reason: impl Display) -> Self

Shorthand for CommandFailed { command: "scan", reason }.

Trait Implementations

impl Debug for CliError

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

Formats the value using the given formatter.

impl Display for CliError

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

Formats the value using the given formatter.

impl Error for CliError

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 CliError

fn from(source: Error) -> Self

Converts to this type from the input type.