Enum Error 

#[non_exhaustive]
pub enum Error {
    Read {
        path: PathBuf,
        detail: String,
    },
    Compose {
        path: PathBuf,
        diagnostics: Vec<String>,
    },
    Codegen {
        path: PathBuf,
        detail: String,
    },
    Write {
        path: PathBuf,
        detail: String,
    },
    NoOutDir,
    Axis {
        flag: &'static str,
        value: String,
        detail: String,
    },
}

What went wrong.

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.

Read

A unit could not be read.

Fields

path: PathBuf

The path as given.

detail: String

What the filesystem said.

Compose

A unit did not compose: it holds an error the front end reported.

Every diagnostic is carried, not just the first — a build that reports one defect per run costs a round trip per defect.

Fields

path: PathBuf

The path as given.

diagnostics: Vec<String>

Every error-severity diagnostic, rendered.

Codegen

The model composed and the emitter refused a type in it.

Fields

path: PathBuf

The path as given.

detail: String

What the emitter said, naming the construct.

Write

The generated module could not be written.

Fields

path: PathBuf

Where it was going.

detail: String

What the filesystem said.

NoOutDir

OUT_DIR was not set and no output directory was chosen.

Cargo sets OUT_DIR for a build script. Reaching this means the caller is not one, and has to say where the output goes.

Axis

A value given to Config::axis is not one its axis recognises.

axis is infallible — it only appends to a list — so this is where a typo in the value string surfaces, the same way an unknown axis value surfaces at zerodds-idlc generate’s command line, just later: there is no command line here to refuse it at.

Fields

flag: &'static str

AxisFlag::flag_name, so the offending call is easy to find among several .axis(...) calls on the same Config.

value: String

The value given.

detail: String

Why it was refused, from the axis’s own policy.

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, f: &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.