Struct Failed 

pub struct Failed {
    pub status: Status,
    pub message: String,
    pub feature: Option<String>,
    pub offset: Option<u32>,
}

Why a command did not succeed.

Fields

status: Status

Which class of failure it is, as the driver names them.

message: String

What went wrong, in a sentence.

feature: Option<String>

The construct the engine has not built, when the status is unsupported.

offset: Option<u32>

Where in the statement, when the failure knows.

Implementations

impl Failed

pub fn said(status: Status, message: impl Into<String>) -> Failed

Builds a failure of a given class.

@param status - the class @param message - what went wrong

pub fn misuse(message: impl Into<String>) -> Failed

Builds the failure a caller’s own mistake deserves.

@param message - what was wrong with the request

pub fn unsupported( feature: impl Into<String>, message: impl Into<String>, ) -> Failed

Builds the failure for something this engine has not built.

@param feature - the construct, named so a caller can act on it @param message - the sentence to show

pub fn from_engine(error: &DbError) -> Failed

Classifies an engine error the way the driver does.

The classification is the driver’s, called rather than copied. There is exactly one place in this repository that decides whether a refusal is unsupported or syntax, and a second copy of that decision here would drift the first time the engine grew a construct.

@param error - the engine’s error

pub fn from_shell(failure: &Failure) -> Failed

Classifies a shell failure, which may or may not carry the engine’s error.

@param failure - what the shell reported

pub fn to_json(&self, command: &str) -> Json

Renders this failure as the object every front end reports.

@param command - the verb that failed

pub fn to_text(&self) -> String

Renders this failure the way a person reads it.

pub fn exit_code(&self) -> i32

Returns the process exit code this failure deserves.

Three for unsupported, so a script can branch on “this engine has not built that” without matching on a message; one for everything else.

Trait Implementations

impl Clone for Failed

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Failed

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

Formats the value using the given formatter.