Enum OpType 

#[non_exhaustive]
pub enum OpType {
    Module(Module),
    FuncDefn(FuncDefn),
    FuncDecl(FuncDecl),
    AliasDecl(AliasDecl),
    AliasDefn(AliasDefn),
    Const(Const),
    Input(Input),
    Output(Output),
    Call(Call),
    CallIndirect(CallIndirect),
    LoadConstant(LoadConstant),
    LoadFunction(LoadFunction),
    DFG(DFG),
    ExtensionOp(ExtensionOp),
    OpaqueOp(OpaqueOp),
    Tag(Tag),
    DataflowBlock(DataflowBlock),
    ExitBlock(ExitBlock),
    TailLoop(TailLoop),
    CFG(CFG),
    Conditional(Conditional),
    Case(Case),
}

The concrete operation types for a node in the HUGR.

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.

Module(Module)

FuncDefn(FuncDefn)

FuncDecl(FuncDecl)

AliasDecl(AliasDecl)

AliasDefn(AliasDefn)

Const(Const)

Input(Input)

Output(Output)

Call(Call)

CallIndirect(CallIndirect)

LoadConstant(LoadConstant)

LoadFunction(LoadFunction)

DFG(DFG)

ExtensionOp(ExtensionOp)

OpaqueOp(OpaqueOp)

Tag(Tag)

DataflowBlock(DataflowBlock)

ExitBlock(ExitBlock)

TailLoop(TailLoop)

CFG(CFG)

Conditional(Conditional)

Case(Case)

Implementations

impl OpType

pub fn as_module(&self) -> Option<&Module>

If is an instance of Module return a reference to it.

pub fn is_module(&self) -> bool

Returns true if the operation is an instance of Module.

impl OpType

pub fn as_func_defn(&self) -> Option<&FuncDefn>

If is an instance of FuncDefn return a reference to it.

pub fn is_func_defn(&self) -> bool

Returns true if the operation is an instance of FuncDefn.

impl OpType

pub fn as_func_decl(&self) -> Option<&FuncDecl>

If is an instance of FuncDecl return a reference to it.

pub fn is_func_decl(&self) -> bool

Returns true if the operation is an instance of FuncDecl.

impl OpType

pub fn as_alias_decl(&self) -> Option<&AliasDecl>

If is an instance of AliasDecl return a reference to it.

pub fn is_alias_decl(&self) -> bool

Returns true if the operation is an instance of AliasDecl.

impl OpType

pub fn as_alias_defn(&self) -> Option<&AliasDefn>

If is an instance of AliasDefn return a reference to it.

pub fn is_alias_defn(&self) -> bool

Returns true if the operation is an instance of AliasDefn.

impl OpType

pub fn as_const(&self) -> Option<&Const>

If is an instance of Const return a reference to it.

pub fn is_const(&self) -> bool

Returns true if the operation is an instance of Const.

impl OpType

pub fn as_input(&self) -> Option<&Input>

If is an instance of Input return a reference to it.

pub fn is_input(&self) -> bool

Returns true if the operation is an instance of Input.

impl OpType

pub fn as_output(&self) -> Option<&Output>

If is an instance of Output return a reference to it.

pub fn is_output(&self) -> bool

Returns true if the operation is an instance of Output.

impl OpType

pub fn as_call(&self) -> Option<&Call>

If is an instance of Call return a reference to it.

pub fn is_call(&self) -> bool

Returns true if the operation is an instance of Call.

impl OpType

pub fn as_call_indirect(&self) -> Option<&CallIndirect>

If is an instance of CallIndirect return a reference to it.

pub fn is_call_indirect(&self) -> bool

Returns true if the operation is an instance of CallIndirect.

impl OpType

pub fn as_load_constant(&self) -> Option<&LoadConstant>

If is an instance of LoadConstant return a reference to it.

pub fn is_load_constant(&self) -> bool

Returns true if the operation is an instance of LoadConstant.

impl OpType

pub fn as_load_function(&self) -> Option<&LoadFunction>

If is an instance of LoadFunction return a reference to it.

pub fn is_load_function(&self) -> bool

Returns true if the operation is an instance of LoadFunction.

impl OpType

pub fn as_dfg(&self) -> Option<&DFG>

If is an instance of DFG return a reference to it.

pub fn is_dfg(&self) -> bool

Returns true if the operation is an instance of DFG.

impl OpType

pub fn as_extension_op(&self) -> Option<&ExtensionOp>

If is an instance of ExtensionOp return a reference to it.

pub fn is_extension_op(&self) -> bool

Returns true if the operation is an instance of ExtensionOp.

impl OpType

pub fn as_tag(&self) -> Option<&Tag>

If is an instance of Tag return a reference to it.

pub fn is_tag(&self) -> bool

Returns true if the operation is an instance of Tag.

impl OpType

pub fn as_dataflow_block(&self) -> Option<&DataflowBlock>

If is an instance of DataflowBlock return a reference to it.

pub fn is_dataflow_block(&self) -> bool

Returns true if the operation is an instance of DataflowBlock.

impl OpType

pub fn as_exit_block(&self) -> Option<&ExitBlock>

If is an instance of ExitBlock return a reference to it.

pub fn is_exit_block(&self) -> bool

Returns true if the operation is an instance of ExitBlock.

impl OpType

pub fn as_tail_loop(&self) -> Option<&TailLoop>

If is an instance of TailLoop return a reference to it.

pub fn is_tail_loop(&self) -> bool

Returns true if the operation is an instance of TailLoop.

impl OpType

pub fn as_cfg(&self) -> Option<&CFG>

If is an instance of CFG return a reference to it.

pub fn is_cfg(&self) -> bool

Returns true if the operation is an instance of CFG.

impl OpType

pub fn as_conditional(&self) -> Option<&Conditional>

If is an instance of Conditional return a reference to it.

pub fn is_conditional(&self) -> bool

Returns true if the operation is an instance of Conditional.

impl OpType

pub fn as_case(&self) -> Option<&Case>

If is an instance of Case return a reference to it.

pub fn is_case(&self) -> bool

Returns true if the operation is an instance of Case.

impl OpType

pub fn other_port_kind(&self, dir: Direction) -> Option<EdgeKind>

The edge kind for the non-dataflow ports of the operation, not described by the signature.

If not None, a single extra port of that kind will be present on the given direction after any dataflow or constant ports.

pub fn static_port_kind(&self, dir: Direction) -> Option<EdgeKind>

The edge kind for the static ports of the operation, not described by the dataflow signature.

If not None, an extra input port of that kind will be present on the given direction after any dataflow ports and before any OpType::other_port_kind ports.

pub fn port_kind(&self, port: impl Into<Port>) -> Option<EdgeKind>

Returns the edge kind for the given port.

The result may be a value port, a static port, or a non-dataflow port. See OpType::dataflow_signature, OpType::static_port_kind, and OpType::other_port_kind.

pub fn other_port(&self, dir: Direction) -> Option<Port>

The non-dataflow port for the operation, not described by the signature. See [OpType::other_port_kind].

Returns None if there is no such port, or if the operation defines multiple non-dataflow ports.

pub fn other_input_port(&self) -> Option<IncomingPort>

The non-dataflow input port for the operation, not described by the signature. See [OpType::other_port].

pub fn other_output_port(&self) -> Option<OutgoingPort>

The non-dataflow output port for the operation, not described by the signature. See [OpType::other_port].

pub fn static_port(&self, dir: Direction) -> Option<Port>

If the op has a static port, the port of that input.

See OpType::static_input_port and OpType::static_output_port.

pub fn static_input_port(&self) -> Option<IncomingPort>

If the op has a static input (Call, LoadConstant, and LoadFunction), the port of that input.

pub fn static_output_port(&self) -> Option<OutgoingPort>

If the op has a static output (Const, FuncDefn, FuncDecl), the port of that output.

pub fn value_ports(&self, dir: Direction) -> impl DoubleEndedIterator

Return the dataflow value ports for the given direction.

See OpType::value_input_ports and OpType::value_output_ports.

pub fn value_input_ports(&self) -> impl DoubleEndedIterator

Return the dataflow value input ports for the given direction.

pub fn value_output_ports(&self) -> impl DoubleEndedIterator

Return the dataflow value output ports for the given direction.

pub fn value_port_count(&self, dir: Direction) -> usize

The number of Value ports in given direction.

pub fn value_input_count(&self) -> usize

The number of Value input ports.

pub fn value_output_count(&self) -> usize

The number of Value output ports.

pub fn port_count(&self, dir: Direction) -> usize

Returns the number of ports for the given direction.

pub fn input_count(&self) -> usize

Returns the number of inputs ports for the operation.

pub fn output_count(&self) -> usize

Returns the number of outputs ports for the operation.

pub fn is_container(&self) -> bool

Checks whether the operation can contain children nodes.

pub fn cast<T>(&self) -> Option<T>

where T: MakeExtensionOp,

Cast to an extension operation.

Returns None if the operation is not of the requested type.

pub fn extension_id(&self) -> Option<&IdentList>

Returns the extension where the operation is defined, if any.

pub fn used_extensions( &self, ) -> Result<ExtensionRegistry, ExtensionCollectionError>

Returns a registry with all the extensions required by the operation.

This includes the operation extension in OpType::extension_id, and any extension required by the operation’s signature types.

Trait Implementations

impl Clone for OpType

fn clone(&self) -> OpType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpType

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

Formats the value using the given formatter.

impl Default for OpType

fn default() -> OpType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OpType

fn deserialize<__D>( __deserializer: __D, ) -> Result<OpType, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OpType

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

Formats the value using the given formatter.

impl From<AliasDecl> for OpType

fn from(v: AliasDecl) -> OpType

Converts to this type from the input type.

impl From<AliasDefn> for OpType

fn from(v: AliasDefn) -> OpType

Converts to this type from the input type.

impl From<CFG> for OpType

fn from(v: CFG) -> OpType

Converts to this type from the input type.

impl From<Call> for OpType

fn from(v: Call) -> OpType

Converts to this type from the input type.

impl From<CallIndirect> for OpType

fn from(v: CallIndirect) -> OpType

Converts to this type from the input type.

impl From<Case> for OpType

fn from(v: Case) -> OpType

Converts to this type from the input type.

impl From<Conditional> for OpType

fn from(v: Conditional) -> OpType

Converts to this type from the input type.

impl From<Const> for OpType

fn from(v: Const) -> OpType

Converts to this type from the input type.

impl From<DFG> for OpType

fn from(v: DFG) -> OpType

Converts to this type from the input type.

impl From<DataflowBlock> for OpType

fn from(v: DataflowBlock) -> OpType

Converts to this type from the input type.

impl From<ExitBlock> for OpType

fn from(v: ExitBlock) -> OpType

Converts to this type from the input type.

impl From<ExtensionOp> for OpType

fn from(v: ExtensionOp) -> OpType

Converts to this type from the input type.

impl From<FuncDecl> for OpType

fn from(v: FuncDecl) -> OpType

Converts to this type from the input type.

impl From<FuncDefn> for OpType

fn from(v: FuncDefn) -> OpType

Converts to this type from the input type.

impl From<Input> for OpType

fn from(v: Input) -> OpType

Converts to this type from the input type.

impl From<LoadConstant> for OpType

fn from(v: LoadConstant) -> OpType

Converts to this type from the input type.

impl From<LoadFunction> for OpType

fn from(v: LoadFunction) -> OpType

Converts to this type from the input type.

impl From<Module> for OpType

fn from(v: Module) -> OpType

Converts to this type from the input type.

impl From<OpaqueOp> for OpType

fn from(v: OpaqueOp) -> OpType

Converts to this type from the input type.

impl From<Output> for OpType

fn from(v: Output) -> OpType

Converts to this type from the input type.

impl<T> From<T> for OpType

where T: MakeRegisteredOp,

fn from(ext_op: T) -> OpType

Convert

impl From<Tag> for OpType

fn from(v: Tag) -> OpType

Converts to this type from the input type.

impl From<TailLoop> for OpType

fn from(v: TailLoop) -> OpType

Converts to this type from the input type.

impl OpParent for OpType

fn inner_function_type(&self) -> Option<Cow<'_, FuncTypeBase<TypeRow>>>

The inner function type of the operation, if it has a child dataflow sibling graph.

Non-container ops like FuncDecl return None even though they represent a function.

impl OpTrait for OpType

fn description(&self) -> &str

A human-readable description of the operation.

fn tag(&self) -> OpTag

Tag identifying the operation.

fn try_node_handle<N, H>(&self, __enum_dispatch_arg_0: N) -> Option<H>

where N: HugrNode, H: NodeHandle<N> + From<N>,

Tries to create a specific NodeHandle for a node with this operation type.

Fails if the operation’s OpTrait::tag does not match the NodeHandle::TAG of the requested handle.

fn dataflow_signature(&self) -> Option<Cow<'_, FuncTypeBase<TypeRow>>>

The signature of the operation.

Only dataflow operations have a signature, otherwise returns None.

fn other_input(&self) -> Option<EdgeKind>

The edge kind for the non-dataflow inputs of the operation, not described by the signature.

If not None, a single extra input port of that kind will be present.

fn other_output(&self) -> Option<EdgeKind>

The edge kind for the non-dataflow outputs of the operation, not described by the signature.

If not None, a single extra output port of that kind will be present.

fn static_input(&self) -> Option<EdgeKind>

The edge kind for a single constant input of the operation, not described by the dataflow signature.

If not None, an extra input port of that kind will be present after the dataflow input ports and before any OpTrait::other_input ports.

fn static_output(&self) -> Option<EdgeKind>

The edge kind for a single constant output of the operation, not described by the dataflow signature.

If not None, an extra output port of that kind will be present after the dataflow input ports and before any OpTrait::other_output ports.

fn non_df_port_count(&self, __enum_dispatch_arg_0: Direction) -> usize

Get the number of non-dataflow multiports.

fn substitute(&self, __enum_dispatch_arg_0: &Substitution<'_>) -> OpType

Apply a type-level substitution to this OpType, i.e. replace type variables with new types.

impl PartialEq for OpType

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

fn partial_cmp(&self, other: &OpType) -> 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 Serialize for OpType

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpType

impl TryInto<AliasDecl> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<AliasDecl, <OpType as TryInto<AliasDecl>>::Error>

Performs the conversion.

impl TryInto<AliasDefn> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<AliasDefn, <OpType as TryInto<AliasDefn>>::Error>

Performs the conversion.

impl TryInto<CFG> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<CFG, <OpType as TryInto<CFG>>::Error>

Performs the conversion.

impl TryInto<Call> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Call, <OpType as TryInto<Call>>::Error>

Performs the conversion.

impl TryInto<CallIndirect> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<CallIndirect, <OpType as TryInto<CallIndirect>>::Error>

Performs the conversion.

impl TryInto<Case> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Case, <OpType as TryInto<Case>>::Error>

Performs the conversion.

impl TryInto<Conditional> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<Conditional, <OpType as TryInto<Conditional>>::Error>

Performs the conversion.

impl TryInto<Const> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Const, <OpType as TryInto<Const>>::Error>

Performs the conversion.

impl TryInto<DFG> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<DFG, <OpType as TryInto<DFG>>::Error>

Performs the conversion.

impl TryInto<DataflowBlock> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<DataflowBlock, <OpType as TryInto<DataflowBlock>>::Error>

Performs the conversion.

impl TryInto<ExitBlock> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<ExitBlock, <OpType as TryInto<ExitBlock>>::Error>

Performs the conversion.

impl TryInto<ExtensionOp> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<ExtensionOp, <OpType as TryInto<ExtensionOp>>::Error>

Performs the conversion.

impl TryInto<FuncDecl> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<FuncDecl, <OpType as TryInto<FuncDecl>>::Error>

Performs the conversion.

impl TryInto<FuncDefn> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<FuncDefn, <OpType as TryInto<FuncDefn>>::Error>

Performs the conversion.

impl TryInto<Input> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Input, <OpType as TryInto<Input>>::Error>

Performs the conversion.

impl TryInto<LoadConstant> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<LoadConstant, <OpType as TryInto<LoadConstant>>::Error>

Performs the conversion.

impl TryInto<LoadFunction> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<LoadFunction, <OpType as TryInto<LoadFunction>>::Error>

Performs the conversion.

impl TryInto<Module> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Module, <OpType as TryInto<Module>>::Error>

Performs the conversion.

impl TryInto<OpaqueOp> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<OpaqueOp, <OpType as TryInto<OpaqueOp>>::Error>

Performs the conversion.

impl TryInto<Output> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Output, <OpType as TryInto<Output>>::Error>

Performs the conversion.

impl TryInto<Tag> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<Tag, <OpType as TryInto<Tag>>::Error>

Performs the conversion.

impl TryInto<TailLoop> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<TailLoop, <OpType as TryInto<TailLoop>>::Error>

Performs the conversion.

impl ValidateOp for OpType

fn validity_flags<N>(&self) -> OpValidityFlags<N>

where N: HugrNode,

Returns a set of flags describing the validity predicates for this operation.

fn validate_op_children<'a, N>( &self, __enum_dispatch_arg_0: impl DoubleEndedIterator<Item = (N, &'a OpType)>, ) -> Result<(), ChildrenValidationError<N>>

where N: HugrNode,

Validate the ordered list of children.