Struct OpDef

pub struct OpDef { /* private fields */ }

Serializable definition for dynamically loaded operations.

TODO: Define a way to construct new OpDef’s from a serialized definition.

Implementations

impl OpDef

pub fn validate_args( &self, args: &[TypeArg], var_decls: &[TypeParam], ) -> Result<(), SignatureError>

Check provided type arguments are valid against their extensions, against parameters, and that no type variables are used as static arguments (to compute_signature)

pub fn compute_signature( &self, args: &[TypeArg], ) -> Result<Signature, SignatureError>

Computes the signature of a node, i.e. an instantiation of this OpDef with statically-provided TypeArgs.

pub fn try_lower( &self, args: &[TypeArg], available_extensions: &ExtensionSet, ) -> Option<Hugr>

Fallibly returns a Hugr that may replace an instance of this OpDef given a set of available extensions that may be used in the Hugr.

pub fn name(&self) -> &OpName

Returns a reference to the name of this OpDef.

pub fn extension_id(&self) -> &ExtensionId

Returns a reference to the extension id of this OpDef.

pub fn extension(&self) -> Weak<Extension>

Returns a weak reference to the extension defining this operation.

pub fn description(&self) -> &str

Returns a reference to the description of this OpDef.

pub fn params(&self) -> Result<&[TypeParam], SignatureError>

Returns a reference to the params of this OpDef.

pub fn add_lower_func(&mut self, lower: LowerFunc)

Add a lowering function to the OpDef

pub fn add_misc(&mut self, k: impl ToString, v: Value) -> Option<Value>

Insert miscellaneous data v to the OpDef, keyed by k.

pub fn set_constant_folder(&mut self, fold: impl ConstFold + 'static)

Set the constant folding function for this Op, which can evaluate it given constant inputs.

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

Evaluate an instance of this OpDef defined by the type_args, given crate::ops::Const values for inputs at crate::IncomingPorts.

pub fn signature_func(&self) -> &SignatureFunc

Returns a reference to the signature function of this OpDef.

Trait Implementations

impl Debug for OpDef

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpDef

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OpDef

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

where __S: Serializer,

Serialize this value into the given Serde serializer.