Struct ExtensionOp

pub struct ExtensionOp { /* private fields */ }

An operation defined by an OpDef from a loaded Extension.

Extension ops are not serializable. They must be downgraded into an OpaqueOp instead. See ExtensionOp::make_opaque.

Implementations

impl ExtensionOp

pub fn new( def: Arc<OpDef>, args: impl Into<Vec<TypeArg>>, ) -> Result<Self, SignatureError>

Create a new ExtensionOp given the type arguments and specified input extensions

pub fn args(&self) -> &[TypeArg]

Return the argument values for this operation.

pub fn def(&self) -> &OpDef

Returns a reference to the OpDef of this ExtensionOp.

pub fn def_arc(&self) -> &Arc<OpDef>

Gets an Arc to the OpDef of this instance, i.e. usable to create new instances.

pub fn constant_fold(&self, consts: &[(IncomingPort, Value)]) -> ConstFoldResult

Attempt to evaluate this operation. See OpDef::constant_fold.

pub fn make_opaque(&self) -> OpaqueOp

Creates a new OpaqueOp as a downgraded version of this ExtensionOp.

Regenerating the ExtensionOp back from the OpaqueOp requires a registry with the appropriate extension.

For a non-cloning version of this operation, use OpaqueOp::from.

pub fn signature_mut(&mut self) -> &mut Signature

Returns a mutable reference to the cached signature of the operation.

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

Cast the operation to an specific extension op.

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

pub fn extension_id(&self) -> &ExtensionId

Returns the extension id of the operation.

pub fn unqualified_id(&self) -> &OpNameRef

Returns the unqualified id of the operation. e.g. ‘iadd’

pub fn qualified_id(&self) -> OpName

Returns the qualified id of the operation. e.g. ‘arithmetic.iadd’

Trait Implementations

impl Clone for ExtensionOp

fn clone(&self) -> ExtensionOp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataflowOpTrait for ExtensionOp

const TAG: OpTag = OpTag::Leaf

Tag identifying the operation.

fn description(&self) -> &str

A human-readable description of the operation.

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

The signature of the operation.

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

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

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

The edge kind for the non-dataflow or constant 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.

impl Debug for ExtensionOp

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

Formats the value using the given formatter.

impl From<ExtensionOp> for OpType

fn from(v: ExtensionOp) -> OpType

Converts to this type from the input type.

impl From<ExtensionOp> for OpaqueOp

fn from(op: ExtensionOp) -> Self

Converts to this type from the input type.

impl OpParent for ExtensionOp

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

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

impl PartialEq for ExtensionOp

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

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<ExtensionOp> for OpType

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValidateOp for ExtensionOp

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 ExtensionOp