Enum CompileError 

#[non_exhaustive]
pub enum CompileError {
    Cancelled(ComputationCancelled),
    BooleanResource(BooleanResourceError),
    InvalidDistance(u32),
    CompiledObjectTargetMismatch {
        object: Box<CompileConfig>,
        linker: Box<CompileConfig>,
    },
    MissingModulePhysicalVariant {
        module: String,
        local_position: IVec3,
        linked_position: IVec3,
        signature: String,
    },
    CliffordProxyPinCount {
        expected: usize,
        actual: usize,
    },
    SelectiveArmSignatureMismatch {
        kind: SelectiveKind,
        reason: String,
    },
    InvalidConnectivity {
        kind: BlockKind,
        connectivity: Connectivity,
    },
    MissingBoundaryBasis {
        kind: BlockKind,
    },
    SpatialPortNeighborNotCube {
        port: IVec3,
        neighbor: IVec3,
    },
    SpatialPortCubeInferenceFailed {
        port: IVec3,
    },
    TallSpatialPortUnsupported {
        port: IVec3,
        height: CubeHeight,
    },
    MultiplexOutputCoordinateUnavailable {
        port: IVec3,
    },
    SpatialHadamardUnsupportedEndpoint {
        pos: IVec3,
    },
    MixedSpatialHadamardUnsupported {
        pos: IVec3,
    },
    CubeHeightTooShort {
        pos: IVec3,
        height: CubeHeight,
        distance: u32,
        rounds: i64,
    },
    BlockLayoutCoordinateOverflow {
        block_xy: IVec2,
        distance: u32,
    },
    OverlappingNodeQubit {
        first: BloqNodeId,
        second: BloqNodeId,
        qubit: IVec2,
    },
    PatchRotationConstructionFailed {
        reason: String,
    },
    NodeFlowCompositionFailed {
        layer: i64,
        members: Vec<IVec3>,
        source: FlowError,
    },
    DetectorFlowCompositionFailed {
        source: FlowError,
    },
    LoopBoundaryMovingOperatorUnsupported,
    ConditionalPauliFeedbackUnsupported,
    TBlockNeedsFreeNeighbor {
        pos: IVec3,
    },
    WalkingConstruction(WalkError),
    ObservableMissingGatewayEntry {
        block_pos: IVec3,
        observable_index: u32,
        local_stabilizer: String,
    },
    ObservableSeamMismatch {
        observable_index: u32,
        lower: IVec3,
        upper: IVec3,
    },
    BranchAssembly {
        reason: String,
    },
    StructuralBranchCliffordProxyUnsupported,
    PaddingRoundsZero,
    Edit(EditError),
    BloqValidation(BloqValidationError),
    CoordinateOverflow(CoordinateOverflowError),
    LogicalBoundaryRebaseOverflow {
        coordinate: IVec2,
        offset: IVec2,
    },
    Circuit(CircuitError),
    RuntimeBasis(RuntimeBasisError),
    SymbolicBasis(SymbolicBasisError),
    OutputCorrection(OutputCorrectionError),
    BlockGraph(BlockGraphError),
    ModuleCertification(ModuleCertificationError),
    Module(Box<ModuleError>),
}

An error raised while validating or compiling a BlockGraph.

Variants cover invalid configuration, unsupported or malformed blocks, observable/detector composition failures, and errors forwarded from the graph, circuit, and IR layers.

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.

Cancelled(ComputationCancelled)

The caller cancelled compilation at a safe checkpoint.

BooleanResource(BooleanResourceError)

Compiler-configured Boolean analysis exceeded a resource limit.

InvalidDistance(u32)

The requested code distance is outside the supported odd range.

CompiledObjectTargetMismatch

A compiled object was linked under a different compile configuration.

Fields

object: Box<CompileConfig>

Configuration used to build the object.

linker: Box<CompileConfig>

Configuration used by the linker.

MissingModulePhysicalVariant

A linked module site has no compiled template matching its physical signature.

Fields

module: String

Module definition containing the site.

local_position: IVec3

Site position within the definition.

linked_position: IVec3

Site position after module linking.

signature: String

Missing physical signature.

CliffordProxyPinCount

A Clifford proxy received the wrong number of selective-block pins.

Fields

expected: usize

Required number of pins.

actual: usize

Supplied number of pins.

SelectiveArmSignatureMismatch

The two per-basis arms must present the same output signature.

Fields

kind: SelectiveKind

Selective block whose arms disagree.

reason: String

Signature difference found between the arms.

InvalidConnectivity

A block’s connected faces are unsupported by fixed-bulk lowering.

Fields

kind: BlockKind

Block kind being validated.

connectivity: Connectivity

Unsupported face connectivity.

MissingBoundaryBasis

A temporal leaf block has no neighboring boundary basis.

Fields

kind: BlockKind

Block kind requiring the basis.

SpatialPortNeighborNotCube

A spatial port is connected to a block that cannot supply cube geometry.

Fields

port: IVec3

Spatial port position.

neighbor: IVec3

Connected non-cube position.

SpatialPortCubeInferenceFailed

A spatial port’s virtual cube kind could not be inferred.

Fields

port: IVec3

Spatial port position.

TallSpatialPortUnsupported

A spatial port borders a cube taller than the substitution supports.

Fields

port: IVec3

Spatial port position.

height: CubeHeight

Unsupported neighboring cube height.

MultiplexOutputCoordinateUnavailable

No unused coordinate is available for a multiplexed logical output.

Fields

port: IVec3

Multiplex port position.

SpatialHadamardUnsupportedEndpoint

A spatial Hadamard wall endpoint is not a cube.

Fields

pos: IVec3

Unsupported endpoint position.

MixedSpatialHadamardUnsupported

One spatial component contains Hadamard walls on both spatial axes.

Fields

pos: IVec3

Position identifying the mixed-axis component.

CubeHeightTooShort

A cube height resolves to fewer than two syndrome rounds.

Fields

pos: IVec3

Cube position.

height: CubeHeight

Authored symbolic height.

distance: u32

Code distance used to resolve the height.

rounds: i64

Resolved syndrome-round count.

BlockLayoutCoordinateOverflow

A block position cannot be mapped into the signed physical coordinate range.

Fields

block_xy: IVec2

Block’s spatial coordinate.

distance: u32

Code distance scaling the coordinate.

OverlappingNodeQubit

Two same-layer nodes own the same physical qubit.

Fields

first: BloqNodeId

First conflicting node.

second: BloqNodeId

Second conflicting node.

qubit: IVec2

Shared physical coordinate.

PatchRotationConstructionFailed

Patch-rotation circuit construction failed.

Fields

reason: String

Construction failure detail.

NodeFlowCompositionFailed

Stabilizer-flow composition failed for one physical node.

Fields

layer: i64

Physical layer containing the node.

members: Vec<IVec3>

Source blocks merged into the node.

source: FlowError

Underlying flow-composition failure.

DetectorFlowCompositionFailed

Program detector-flow composition failed.

Fields

source: FlowError

Underlying flow-composition failure.

LoopBoundaryMovingOperatorUnsupported

A repeat boundary contains an unsupported moving residual operator.

ConditionalPauliFeedbackUnsupported

A generated conditional Pauli cannot use the supported feedback paths.

TBlockNeedsFreeNeighbor

A T block has no free neighboring cell for its cultivation spill.

Fields

pos: IVec3

T-block position.

WalkingConstruction(WalkError)

Walking-block circuit construction failed.

ObservableMissingGatewayEntry

Observable lowering found no gateway entry for a local stabilizer.

Fields

block_pos: IVec3

Source block position.

observable_index: u32

Observable being lowered.

local_stabilizer: String

Diagnostic description of the missing local gateway key.

ObservableSeamMismatch

A logical boundary operator disagrees across a temporal seam.

Fields

observable_index: u32

Observable being lowered.

lower: IVec3

Lower seam endpoint.

upper: IVec3

Upper seam endpoint.

BranchAssembly

Continuing-branch assembly cannot be scheduled.

Fields

reason: String

Scheduling failure detail.

StructuralBranchCliffordProxyUnsupported

A Clifford proxy was requested for a graph with structural branches.

PaddingRoundsZero

Memory padding was requested with zero rounds.

Edit(EditError)

An IR seam edit failed.

BloqValidation(BloqValidationError)

The generated Bloq program failed validation.

CoordinateOverflow(CoordinateOverflowError)

Physical coordinate arithmetic overflowed.

LogicalBoundaryRebaseOverflow

Rebasing a logical boundary exceeded the signed coordinate range.

Fields

coordinate: IVec2

Boundary coordinate before rebasing.

offset: IVec2

Physical patch offset.

Circuit(CircuitError)

Circuit construction failed.

RuntimeBasis(RuntimeBasisError)

Runtime stabilizer-basis construction failed.

SymbolicBasis(SymbolicBasisError)

Symbolic stabilizer-basis construction failed.

OutputCorrection(OutputCorrectionError)

Logical output-correction construction failed.

BlockGraph(BlockGraphError)

Source block-graph validation or analysis failed.

ModuleCertification(ModuleCertificationError)

Module certification failed.

Module(Box<ModuleError>)

Hierarchical block-graph validation or linking failed.

Implementations

impl CompileError

pub fn is_resource_limited(&self) -> bool

Whether computation stopped at a work or allocation budget, rather than proving the source or resulting IR invalid.

pub fn is_cancelled(&self) -> bool

Whether the caller cancelled this computation, including a forwarded graph-analysis failure.

pub fn resource_limit_help(&self) -> Option<&'static str>

Configuration help when a compilation-certification limit was exceeded.

Standalone IR validation and circuit-flattening limits have separate configuration contracts and return no certification hint here.

Trait Implementations

impl Debug for CompileError

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

Formats the value using the given formatter.

impl Display for CompileError

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

Formats the value using the given formatter.

impl Error for CompileError

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<BlockGraphError> for CompileError

fn from(source: BlockGraphError) -> Self

Converts to this type from the input type.

impl From<BloqValidationError> for CompileError

fn from(source: BloqValidationError) -> Self

Converts to this type from the input type.

impl From<BooleanResourceError> for CompileError

fn from(source: BooleanResourceError) -> Self

Converts to this type from the input type.

impl From<Box<ModuleError>> for CompileError

fn from(source: Box<ModuleError>) -> Self

Converts to this type from the input type.

impl From<CircuitError> for CompileError

fn from(source: CircuitError) -> Self

Converts to this type from the input type.

impl From<ComputationCancelled> for CompileError

fn from(source: ComputationCancelled) -> Self

Converts to this type from the input type.

impl From<CoordinateOverflowError> for CompileError

fn from(source: CoordinateOverflowError) -> Self

Converts to this type from the input type.

impl From<EditError> for CompileError

fn from(source: EditError) -> Self

Converts to this type from the input type.

impl From<InvalidDistance> for CompileError

fn from(err: InvalidDistance) -> Self

Converts to this type from the input type.

impl From<ModuleCertificationError> for CompileError

fn from(source: ModuleCertificationError) -> Self

Converts to this type from the input type.

impl From<ModuleError> for CompileError

fn from(error: ModuleError) -> Self

Converts to this type from the input type.

impl From<OutputCorrectionError> for CompileError

fn from(source: OutputCorrectionError) -> Self

Converts to this type from the input type.

impl From<RuntimeBasisError> for CompileError

fn from(source: RuntimeBasisError) -> Self

Converts to this type from the input type.

impl From<SymbolicBasisError> for CompileError

fn from(source: SymbolicBasisError) -> Self

Converts to this type from the input type.