Struct Module

pub struct Module {}

The root of a module, parent of all other OpTypes.

Implementations

impl Module

pub const fn new() -> Self

Construct a new Module.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Default for Module

fn default() -> Module

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Module

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Module> for OpType

fn from(v: Module) -> OpType

Converts to this type from the input type.

impl OpParent for Module

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

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

impl OpTrait for Module

fn description(&self) -> &'static str

A human-readable description of the operation.

fn tag(&self) -> OpTag

Tag identifying the operation.

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.

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

The signature of the operation.

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

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

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

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

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

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

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

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

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

Get the number of non-dataflow multiports.

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

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

impl PartialEq for Module

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticTag for Module

const TAG: OpTag = OpTag::ModuleRoot

The name of the operation.

impl<'a> TryFrom<&'a OpType> for &'a Module

type Error = ()

The type returned in the event of a conversion error.

fn try_from(optype: &'a OpType) -> Result<Self, Self::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, <Self as TryInto<Module>>::Error>

Performs the conversion.

impl ValidateOp for Module

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

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

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

Validate the ordered list of children.

impl Eq for Module

impl StructuralPartialEq for Module