Enum OptError 

#[non_exhaustive]
pub enum OptError {
    Module(ModuleError),
    InvalidInput {
        func: FuncId,
        error: ValidationError,
    },
    InvalidOutput {
        func: FuncId,
        pass: PassKind,
        error: ValidationError,
    },
    Build {
        func: FuncId,
        pass: PassKind,
        error: BuildError,
    },
}

Why optimization stopped.

Optimizing a valid function never fails: OptError::InvalidInput means the IR handed in was not valid (nothing was changed), and the other variants mean a pass produced IR the validator rejects, which is a defect in this crate (please report it with the input). A function that runs out of budget is not an error: it is left valid, partly optimized, and counted in Stats::budget_exhausted.

Examples

use ir_lang::{FuncId, Module};
use opt_lang::OptError;

let mut m = Module::new("m");
let err = opt_lang::Optimizer::new()
    .run_function(&mut m, FuncId::from_u32(3))
    .unwrap_err();
assert!(matches!(err, OptError::Module(_)));

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.

Module(ModuleError)

The function is unknown or has no body.

InvalidInput

The function did not validate before optimization; it was left untouched.

Fields

func: FuncId

The function.

error: ValidationError

What the validator reported.

InvalidOutput

A pass left the function invalid (a defect in this crate). Reported only when validation between passes is on, which it is by default in debug builds and tests.

Fields

func: FuncId

The function.

pass: PassKind

The pass that ran last.

error: ValidationError

What the validator reported.

Build

The IR builder refused a rewrite a pass attempted (a defect in this crate). The function may be partly rewritten.

Fields

func: FuncId

The function.

pass: PassKind

The pass.

error: BuildError

What the builder reported.

Trait Implementations

impl Clone for OptError

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 OptError

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

Formats the value using the given formatter.

impl Display for OptError

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

Formats the value using the given formatter.

impl Eq for OptError

impl Error for OptError

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<ModuleError> for OptError

fn from(e: ModuleError) -> Self

Converts to this type from the input type.

impl PartialEq for OptError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OptError