Enum BuildError 

#[non_exhaustive]
pub enum BuildError {
    AlreadyTerminated {
        block: Block,
    },
    UnknownBlock {
        block: Block,
    },
    UnknownInst {
        inst: Inst,
    },
    UnknownValue {
        value: Value,
    },
    UnknownParam {
        index: usize,
    },
    EntryBlock,
    UnknownBlockParam {
        block: Block,
        index: usize,
    },
    Invalid(ValidationErrorKind),
    CapacityExceeded,
    UnknownVariable {
        var: Variable,
    },
    SealedBlock {
        block: Block,
    },
    NotBlockParam {
        value: Value,
    },
    VariablesActive,
    BudgetExceeded,
}

Why a Builder operation was refused.

The builder checks each instruction and terminator as it is added, so a lowering bug is reported at the call that caused it. Nothing is ever changed by a refused operation.

Examples

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

let mut m = Module::new("m");
let f = m.declare_function("f", &Signature::new(&[], &[]), Linkage::Export)?;
let mut b = m.build(f)?;
b.ret(&[])?;
// A terminator is never silently overwritten.
let entry = b.func().entry();
assert_eq!(b.unreachable(), Err(BuildError::AlreadyTerminated { block: entry }));

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.

AlreadyTerminated

The block already has a terminator. Remove it first (Builder::remove_terminator) to replace it.

Fields

block: Block

The block.

UnknownBlock

The block handle is unknown or the block was removed.

Fields

block: Block

The block.

UnknownInst

The instruction handle is unknown or the instruction was removed.

Fields

inst: Inst

The instruction.

UnknownValue

The value handle is unknown.

Fields

value: Value

The value.

UnknownParam

There is no function parameter at this index.

Fields

index: usize

The index.

EntryBlock

The entry block cannot be removed or split off.

UnknownBlockParam

A block parameter index is out of range.

Fields

block: Block

The block.

index: usize

The index.

Invalid(ValidationErrorKind)

The instruction or terminator is ill-formed.

CapacityExceeded

A function table reached its capacity (u32::MAX - 1 entries).

UnknownVariable

The variable was not declared by this builder (or the builder’s variable state was dropped by compact).

Fields

var: Variable

The variable.

SealedBlock

An edge targets a block that was sealed: every edge into it was declared to exist already (Builder::seal_block).

Fields

block: Block

The sealed block.

NotBlockParam

The value is not a parameter of a live block.

Fields

value: Value

The value.

VariablesActive

The operation conflicts with variable construction in progress: splitting a block while blocks are unsealed, or adding a parameter to a block the construction already added parameters to.

BudgetExceeded

A whole-function transformation would exceed its work budget (Builder::insert_statepoints_within); nothing was changed.

Trait Implementations

impl Clone for BuildError

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 BuildError

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

Formats the value using the given formatter.

impl Display for BuildError

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

Formats the value using the given formatter.

impl Eq for BuildError

impl Error for BuildError

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<ValidationErrorKind> for BuildError

fn from(kind: ValidationErrorKind) -> Self

Converts to this type from the input type.

impl PartialEq for BuildError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BuildError