Enum Error 

pub enum Error {
    CargoMetadata(Error),
    RustdocInvocation {
        message: String,
    },
    RustdocParse(Error),
    FormatVersionMismatch {
        expected: u32,
        found: u32,
    },
    Io(Error),
    Config {
        message: String,
    },
    Generate {
        source: Box<Error>,
        index_summary: String,
    },
}

All errors produced by the aidoc pipeline.

Variants

CargoMetadata(Error)

cargo metadata failed while enumerating workspace crates.

RustdocInvocation

Invoking cargo +nightly rustdoc failed at the process level (non-zero exit, missing toolchain, etc.).

Fields

message: String

Human-readable description of the failure.

RustdocParse(Error)

Parsing the rustdoc JSON output failed.

FormatVersionMismatch

The rustdoc JSON output uses a format_version this crate does not yet support. Bumping rustdoc-types is the typical fix.

Fields

expected: u32

The format_version this crate was built against.

found: u32

The format_version actually present in the JSON payload.

Io(Error)

An I/O error while reading rustdoc JSON or writing output artifacts.

Config

Configuration parsing or validation failed (bad [package.metadata.aidoc], unknown projection, etc.).

Fields

message: String

Human-readable description of the failure.

Generate

The generate stage failed. Carries a compact index-stage summary so callers can report both the successful indexing pass and the failure site without an out-of-band channel.

Fields

source: Box<Error>

The underlying failure from the generate stage.

index_summary: String

Compact human-readable summary of the completed index stage.

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

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.