Enum ValueInstruction 

pub enum ValueInstruction {
    Instruction(Instruction),
    ClassicalControl(ValueClassicalControlOp),
}

A value-level instruction for circuit construction.

ValueInstruction is the construction-IR counterpart of Instruction. It has two families of variants:

• Instruction(Instruction) — all non-control-flow operations (gates, directives, classical data). The wrapped Instruction must not be Instruction::ClassicalControl; use ValueInstruction::ClassicalControl for control flow.
• ClassicalControl(ValueClassicalControlOp) — value-level classical control flow whose bodies recursively contain ValueOperation entries with ParameterValue parameters.

Conversion to Storage IR

Circuit::from_operations recursively converts every ValueInstruction into an Instruction:

• ValueInstruction::Instruction(inst) → inst (pass-through, validated to not be ClassicalControl).
• ValueInstruction::ClassicalControl(vcc) → Instruction::ClassicalControl(cc), where every nested ValueControlBody is recursively converted to a ControlBody with interned parameters.

Variants

Instruction(Instruction)

A non-control-flow instruction. The wrapped Instruction must not be Instruction::ClassicalControl.

ClassicalControl(ValueClassicalControlOp)

A value-level classical control-flow operation.

Implementations

impl ValueInstruction

pub fn from_instruction(inst: Instruction) -> Self

Creates a ValueInstruction from a non-control-flow Instruction.

Panics

Panics in debug builds if inst is Instruction::ClassicalControl. Use ValueInstruction::ClassicalControl for control flow.

pub fn is_classical_control(&self) -> bool

Returns true if this is a classical control-flow instruction.

pub fn is_instruction(&self) -> bool

Returns true if this is a non-control-flow instruction.

pub fn name(&self) -> String

Returns the human-readable instruction name.

pub fn instruction_type(&self) -> &'static str

Returns a stable category name for this instruction.

pub fn is_standard(&self) -> bool

Returns true if this is a standard-gate instruction.

pub fn is_mcgate(&self) -> bool

Returns true if this is a multi-controlled-gate instruction.

pub fn is_unitary(&self) -> bool

Returns true if this is a user-defined unitary instruction.

pub fn is_circuit_gate(&self) -> bool

Returns true if this is a circuit-backed gate instruction.

pub fn is_directive(&self) -> bool

Returns true if this is a non-unitary directive.

pub fn is_classical_data(&self) -> bool

Returns true if this is a classical-data instruction.

pub fn is_delay(&self) -> bool

Returns true if this is a delay instruction.

pub fn standard_gate(&self) -> Option<StandardGate>

Returns the standard gate when this is a standard-gate instruction.

pub fn directive(&self) -> Option<Directive>

Returns the directive when this is a directive instruction.

pub fn mc_gate(&self) -> Option<&MCGate>

Returns the multi-controlled gate when this is an mc-gate instruction.

pub fn unitary_gate(&self) -> Option<&UnitaryGate>

Returns the user-defined unitary gate when this is a unitary instruction.

pub fn circuit_gate(&self) -> Option<&CircuitGate>

Returns the circuit-backed gate when this is a circuit-gate instruction.

pub fn classical_data(&self) -> Option<&ClassicalDataOp>

Returns the classical data operation when this is a classical-data instruction.

pub fn classical_control(&self) -> Option<&ValueClassicalControlOp>

Returns the value-level control-flow operation when this is a classical control-flow instruction.

pub fn as_instruction(&self) -> Option<&Instruction>

Returns the wrapped storage instruction when this is a non-control-flow value instruction.

pub fn into_instruction(self) -> Option<Instruction>

Consumes this value instruction and returns the wrapped storage instruction when it is non-control-flow.

Trait Implementations

impl Clone for ValueInstruction

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 ValueInstruction

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

Formats the value using the given formatter.

impl Display for ValueInstruction

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

Formats the value using the given formatter.

impl From<Instruction> for ValueInstruction

fn from(inst: Instruction) -> Self

Converts a non-control-flow Instruction into a ValueInstruction.

Panics

Panics in debug builds if the instruction is Instruction::ClassicalControl.

impl From<ValueClassicalControlOp> for ValueInstruction

fn from(op: ValueClassicalControlOp) -> Self

Converts to this type from the input type.

impl PartialEq for ValueInstruction

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValueInstruction