Enum Error 

#[non_exhaustive]
pub enum Error {
    Incomplete {
        field: String,
        context: ErrorContext,
    },
    Io(Error),
    ParseLine {
        context: ErrorContext,
    },
    UnknownVariable {
        variable: String,
        context: ErrorContext,
    },
    ParseInt {
        source: ParseIntError,
        context: ErrorContext,
    },
    Duplicate {
        variable: String,
        context: ErrorContext,
    },
    Parse {
        message: String,
        context: ErrorContext,
    },
}

Error type for pkg_summary(5) parsing operations.

Each error variant includes an ErrorContext with span information that can be used with error reporting libraries like ariadne or miette.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Incomplete

The summary is incomplete due to a missing required field.

Fields

field: String

The name of the missing field.

context: ErrorContext

Location context for this error.

Io(Error)

An underlying I/O error.

ParseLine

The supplied line is not in the correct VARIABLE=VALUE format.

Fields

context: ErrorContext

Location context for this error.

UnknownVariable

The supplied variable is not a valid pkg_summary(5) variable.

Fields

variable: String

The unknown variable name.

context: ErrorContext

Location context for this error.

ParseInt

Parsing a supplied value as an Integer type failed.

Fields

source: ParseIntError

The underlying parse error.

context: ErrorContext

Location context for this error.

Duplicate

A duplicate value was found for a single-value field.

Fields

variable: String

The name of the duplicated variable.

context: ErrorContext

Location context for this error.

Parse

A generic parse error from the kv module.

Fields

message: String

The error message.

context: ErrorContext

Location context for this error.

Implementations

impl Error

pub fn entry(&self) -> Option<usize>

Returns the entry index where the error occurred.

Only set when parsing multiple entries via Summary::from_reader.

pub fn span(&self) -> Option<Span>

Returns the span information for this error.

The span contains the byte offset and length of the problematic region.

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.

impl From<Error> for Error

fn from(e: Error) -> Self

Converts to this type from the input type.