Enum CliError 

pub enum CliError {
    Io(Error),
    Config(String),
    Schema(String),
    Validation(String),
    Migration(String),
    Database(String),
    Unreachable(String),
    FeatureUnavailable(String),
    Command(String),
    Format(String),
    Codegen(String),
}

CLI error types

Variants

Io(Error)

IO error

Config(String)

Configuration error

Schema(String)

Schema parsing error

Validation(String)

Validation error

Migration(String)

Migration error

Database(String)

Database error

Unreachable(String)

Database unreachable — the connection could not be established (host down, refused, timeout, DNS). Distinct from CliError::Database (connected, but a query failed) so callers such as migrate dev can treat “no database reachable” as a greenfield source while still surfacing genuine query/auth errors against a reachable server.

FeatureUnavailable(String)

The requested backend’s introspection support was not compiled in (its cargo feature is off). Callers such as migrate dev treat this like an unreachable database (greenfield source) rather than a hard error, so it is a distinct variant from CliError::Config to avoid routing on the human-readable message text.

Command(String)

Command error

Format(String)

Format error

Codegen(String)

Code generation error

Trait Implementations

impl Debug for CliError

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

Formats the value using the given formatter.

impl Diagnostic for CliError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

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.

impl From<Error> for CliError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CliError

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<LoadError> for CliError

fn from(e: LoadError) -> Self

Converts to this type from the input type.

impl From<SchemaError> for CliError

fn from(e: SchemaError) -> Self

Converts to this type from the input type.