Enum hugr::ops::OpTag

#[non_exhaustive]
pub enum OpTag {
    Any,
    None,
    ModuleOp,
    ModuleRoot,
    Function,
    Alias,
    Const,
    FuncDefn,
    ControlFlowChild,
    DataflowChild,
    DataflowParent,
    Dfg,
    Cfg,
    Input,
    Output,
    StaticInput,
    StaticOutput,
    FnCall,
    LoadConst,
    LoadFunc,
    ScopedDefn,
    TailLoop,
    Conditional,
    Case,
    Leaf,
    DataflowBlock,
    BasicBlockExit,
}

Tags for sets of operation kinds.

This can mark either specific operations, or sets of operations allowed in regions.

Uses a flat representation for all the variants, in contrast to the complex OpType structures.

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.

Any

All operations allowed.

None

No valid operation types.

ModuleOp

Non-root module operations.

ModuleRoot

Root module operation.

Function

A function definition or declaration.

Alias

A type alias.

Const

A constant declaration.

FuncDefn

A function definition.

ControlFlowChild

Node in a Control-flow Sibling Graph.

DataflowChild

Node in a Dataflow Sibling Graph.

DataflowParent

Parent node of a Dataflow Sibling Graph.

Dfg

A nested data-flow operation.

Cfg

A nested control-flow operation.

Input

A dataflow input.

Output

A dataflow output.

StaticInput

Dataflow node that has a static input

StaticOutput

Node that has a static output

FnCall

A function call.

LoadConst

A constant load operation.

LoadFunc

A function load operation.

ScopedDefn

A definition that could be at module level or inside a DSG.

TailLoop

A tail-recursive loop.

Conditional

A conditional operation.

Case

A case op inside a conditional.

Leaf

A leaf operation.

DataflowBlock

A control flow basic block defining a dataflow graph.

BasicBlockExit

A control flow exit node.

Implementations

impl OpTag

pub const fn is_superset(self, other: OpTag) -> bool

Returns true if this tag is more general than other.

pub const fn description(&self) -> &str

Returns a user-friendly description of the set.

pub const fn is_empty(&self) -> bool

Returns whether the set is empty.

pub const fn eq(self, other: OpTag) -> bool

Constant equality check.

Trait Implementations

impl Clone for OpTag

fn clone(&self) -> OpTag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpTag

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

Formats the value using the given formatter.

impl Default for OpTag

fn default() -> OpTag

Returns the “default value” for a type.

impl Display for OpTag

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

Formats the value using the given formatter.

impl PartialEq for OpTag

fn eq(&self, other: &OpTag) -> 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 PartialOrd for OpTag

fn partial_cmp(&self, other: &OpTag) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for OpTag

impl Eq for OpTag

impl StructuralPartialEq for OpTag