Struct ValidationError 

pub struct ValidationError { /* private fields */ }

Why a module is not well-formed: what is wrong, and where.

Module::validate returns the first problem it finds in a fixed order (module declarations, then each function in handle order; within a function: structure, instructions, terminators, exception edges, dominance, safepoints).

Examples

use ir_lang::{Linkage, Module, Signature, Type, ValidationErrorKind};

let mut m = Module::new("m");
let f = m.declare_function("f", &Signature::new(&[], &[Type::I32]), Linkage::Export)?;
// Exported but never given a body.
let err = m.validate().unwrap_err();
assert_eq!(err.func(), Some(f));
assert_eq!(err.kind(), &ValidationErrorKind::MissingBody);

Implementations

impl ValidationError

pub fn func(&self) -> Option<FuncId>

The function the problem is in, if it is inside one.

See ValidationError for an example.

pub fn block(&self) -> Option<Block>

The block the problem is in, if any.

Examples

use ir_lang::{Linkage, Module, Signature};

let mut m = Module::new("m");
let f = m.declare_function("f", &Signature::new(&[], &[]), Linkage::Export)?;
let _ = m.build(f)?; // the entry block is never terminated
let err = m.validate().unwrap_err();
assert_eq!(err.block().map(|b| b.index()), Some(0));

pub fn inst(&self) -> Option<Inst>

The instruction the problem is in, if it is in one (None for a terminator or a block-level problem).

Examples

use ir_lang::{Linkage, Module, Signature};

let mut m = Module::new("m");
let f = m.declare_function("f", &Signature::new(&[], &[]), Linkage::Export)?;
let _ = m.build(f)?;
assert_eq!(m.validate().unwrap_err().inst(), None);

pub fn kind(&self) -> &ValidationErrorKind

What is wrong.

See ValidationError for an example.

Trait Implementations

impl Clone for ValidationError

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 ValidationError

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

Formats the value using the given formatter.

impl Display for ValidationError

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

Formats the value using the given formatter.

impl Eq for ValidationError

impl Error for ValidationError

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValidationError