Enum Error 

pub enum Error {
    ParseContext {
        display_name: String,
        source_text: Box<str>,
        start_line: usize,
        barrier_context: bool,
        diagnostic: ParseDiagnostic,
    },
    Config {
        path: PathBuf,
        details: FileParseError,
        source_message: Box<str>,
    },
    Spec {
        path: PathBuf,
        details: FileParseError,
        source_message: Box<str>,
    },
    Io(Error),
    Formatter(String),
    LayoutTooWide {
        line_no: usize,
        width: usize,
        limit: usize,
    },
}

Errors that can be returned by parsing, config loading, spec loading, or formatting operations.

Variants

ParseContext

A parser error annotated with source text and line-offset context.

Fields

display_name: String

Human-facing source name, for example a path or <stdin>.

source_text: Box<str>

The source text that failed to parse.

start_line: usize

The 1-based source line number where this parser chunk started.

barrier_context: bool

Whether earlier barrier/fence handling affected how this chunk was parsed.

diagnostic: ParseDiagnostic

Structured parser diagnostic.

Config

A user config parse error.

Fields

path: PathBuf

The config file that failed to deserialize.

details: FileParseError

Structured parser details for the failure.

source_message: Box<str>

Cached display string used by thiserror.

Spec

A built-in or user override spec parse error.

Fields

path: PathBuf

The spec file that failed to deserialize.

details: FileParseError

Structured parser details for the failure.

source_message: Box<str>

Cached display string used by thiserror.

Io(Error)

A filesystem or stream I/O failure.

Formatter(String)

A higher-level formatter or CLI error that does not fit another structured variant.

LayoutTooWide

A formatted line exceeded the configured line width and require_valid_layout is enabled.

Fields

line_no: usize

1-based line number in the formatted output.

width: usize

Actual character width of the offending line.

limit: usize

Configured [Config::line_width] limit.

Implementations

impl Error

pub fn with_display_name(self, display_name: impl Into<String>) -> Self

Attach a human-facing source name to a contextual parser error.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.