Enum CliError 

pub enum CliError {
    Database(Error),
    Io(Error),
    InvalidArgument(String),
    ProfileNotFound(String),
    ConflictingOptions,
    InvalidTransactionId(String),
    TransactionTimeout(String),
    Timeout(String),
    Cancelled,
    NoQueryProvided,
    UnknownIndexType(String),
    UnknownCompressionType(String),
    IncompatibleVersion {
        cli: String,
        file: String,
    },
    S3(String),
    Credentials(String),
    Parse(String),
    Json(Error),
    ServerConnection(String),
    ServerUnsupported(String),
    DistributedReadOutcome {
        outcome: String,
        reason: String,
        exit_code: ExitCode,
    },
    ClusterManagementOutcome {
        outcome: String,
        reason: String,
        exit_code: ExitCode,
    },
}

CLI-specific error type.

This enum represents all possible errors that can occur during CLI operations.

Variants

Database(Error)

An error from the underlying database layer.

Io(Error)

An I/O error occurred.

InvalidArgument(String)

An invalid argument was provided.

ProfileNotFound(String)

A specified profile was not found.

ConflictingOptions

Conflicting CLI options were provided.

InvalidTransactionId(String)

A transaction ID is invalid.

TransactionTimeout(String)

A transaction timed out and was rolled back.

Timeout(String)

A query exceeded its deadline.

Cancelled

A query was cancelled by the user.

NoQueryProvided

No SQL query was provided.

UnknownIndexType(String)

An unknown index type was specified.

UnknownCompressionType(String)

An unknown compression type was specified.

IncompatibleVersion

File format is incompatible with the CLI version.

Fields

cli: String

file: String

S3(String)

An S3-related error occurred.

Credentials(String)

Credentials are missing or invalid.

Parse(String)

A parsing error occurred.

Json(Error)

A JSON serialization/deserialization error occurred.

ServerConnection(String)

A server connection error occurred.

ServerUnsupported(String)

A server does not support the requested command.

DistributedReadOutcome

Classified terminal outcome of a distributed SQL read. Its exit code is fixed by the wire/CLI classification rather than by a generic error.

Fields

outcome: String

reason: String

exit_code: ExitCode

ClusterManagementOutcome

A cluster management request completed with a classified non-success outcome. The response was already written to stdout before this error is returned, preserving the operation ID for automation.

Fields

outcome: String

reason: String

exit_code: ExitCode

Implementations

impl CliError

Return the process exit class associated with an error. Most CLI failures remain the legacy generic error code; a cluster management response can instead retain its explicit terminal, retryable, pending, or authorization classification.

pub fn exit_code(&self) -> ExitCode

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.

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(source: Error) -> Self

Converts to this type from the input type.