hugr_core::ops

Trait OpTrait

Source 
pub trait OpTrait: Sized + Clone {
    // Required methods
    fn description(&self) -> &str;
    fn tag(&self) -> OpTag;

    // Provided methods
    fn try_node_handle<N, H>(&self, node: N) -> Option<H>
       where N: HugrNode,
             H: NodeHandle<N> + From<N> { ... }
    fn dataflow_signature(&self) -> Option<Cow<'_, Signature>> { ... }
    fn other_input(&self) -> Option<EdgeKind> { ... }
    fn other_output(&self) -> Option<EdgeKind> { ... }
    fn static_input(&self) -> Option<EdgeKind> { ... }
    fn static_output(&self) -> Option<EdgeKind> { ... }
    fn non_df_port_count(&self, dir: Direction) -> usize { ... }
    fn substitute(&self, _subst: &Substitution<'_>) -> Self { ... }
}
Expand description

Trait implemented by all OpType variants.

Required Methods§

Source

fn description(&self) -> &str

A human-readable description of the operation.

Source

fn tag(&self) -> OpTag

Tag identifying the operation.

Provided Methods§

Source

fn try_node_handle<N, H>(&self, node: 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.

Source

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

The signature of the operation.

Only dataflow operations have a signature, otherwise returns None.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Get the number of non-dataflow multiports.

Source

fn substitute(&self, _subst: &Substitution<'_>) -> Self

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

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§