Enum CodegenError 

#[non_exhaustive]
pub enum CodegenError {
    InvalidIr(ValidationError),
}

The reason a Backend could not lower a function.

Lowering needs well-formed SSA: every value defined before it is used, every branch targeting a real block with arguments that match its parameters, every operation applied to operands of the right type. A backend checks that up front with Function::validate and refuses to emit code for input that fails, rather than producing a program that is wrong in a way the IR already forbids.

The set is #[non_exhaustive]: a backend that performs target-specific checks may report failures the bytecode backend never does, so a match on this type must include a wildcard arm.

Examples

use codegen_lang::{compile, CodegenError};
use ir_lang::{Builder, Type};

// A function whose entry block never receives a terminator is not well-formed.
let func = Builder::new("f", &[], Type::Unit).finish();
match compile(&func) {
    Err(CodegenError::InvalidIr(reason)) => {
        assert!(reason.to_string().contains("terminator"));
    }
    other => panic!("expected an InvalidIr error, got {other:?}"),
}

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.

InvalidIr(ValidationError)

The input function did not pass Function::validate. The wrapped ValidationError names the offending block or value and explains the violation; fix the lowering that produced the IR and try again.

Trait Implementations

impl Clone for CodegenError

fn clone(&self) -> CodegenError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CodegenError

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CodegenError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CodegenError

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

Formats the value using the given formatter.

impl Error for CodegenError

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<ValidationError> for CodegenError

fn from(reason: ValidationError) -> Self

Converts to this type from the input type.

impl PartialEq for CodegenError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CodegenError

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CodegenError