Struct Fail 

pub struct Fail {
    pub code: Code,
    pub message: String,
    pub path: Option<String>,
    pub limit: Option<Box<Limit>>,
    pub row: Option<u64>,
    pub column: Option<u64>,
    pub file: Option<Box<str>>,
    pub committed_output: bool,
}

A failure: a code, and what is known about where and why.

committed_output says whether bytes had already been written when the failure was found: an incremental export cannot take them back, and the caller must be told the output may be partial.

Fields

code: Code

message: String

path: Option<String>

The input path the failure concerns, in jq syntax, when one applies.

limit: Option<Box<Limit>>

Boxed, with the file below, so that a Fail stays small enough to return by value on every failure path without a warning.

row: Option<u64>

1-based source row and column, when the failure has a position.

column: Option<u64>

file: Option<Box<str>>

The source file the position is in, when the program the failure came from was compiled from several (a format’s parts linked with a program); absent, the position is the one source’s.

committed_output: bool

Implementations

impl Fail

pub fn new(code: Code, message: impl Into<String>) -> Fail

pub fn in_file(self, file: impl Into<Box<str>>) -> Fail

The failure with the source file its position is in.

pub fn at_path(self, path: impl Into<String>) -> Fail

pub fn at(self, row: u64, column: u64) -> Fail

pub fn committed(self) -> Fail

pub fn limit(name: &'static str, value: u64, message: impl Into<String>) -> Fail

A limit failure, named after the Limits field that was passed.

pub fn protocol(message: impl Into<String>) -> Fail

pub fn input(message: impl Into<String>) -> Fail

pub fn output(message: impl Into<String>) -> Fail

pub fn aborted() -> Fail

pub fn from_tabnas(e: &TabnasError) -> Fail

The engine’s own error, as an input failure carrying its code, position and report. With the tabnas feature, which the language feature turns on.

pub fn to_json(&self) -> Value

The failure as a JSON object: code, message, and path, limit ({name, value}), row, col, output (“partial” or “none”) when they apply. This is the shape hosts print.

Trait Implementations

impl Clone for Fail

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 Fail

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

Formats the value using the given formatter.

impl Display for Fail

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

Formats the value using the given formatter.

impl Error for Fail

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 PartialEq for Fail

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Fail