Module hugr_core::extension

Extensions

TODO: YAML declaration and parsing. This should be similar to a plugin system (outside the types module), which also parses nested OpDefs.

Re-exports

• pub use prelude::PRELUDE;
• pub use prelude::PRELUDE;
• pub use prelude::PRELUDE_REGISTRY;
• pub use prelude::PRELUDE_REGISTRY;

Modules

• declarative
  Declarative extension definitions.
• prelude
  Prelude extension - available in all contexts, defining common types, operations and constants.
• simple_op
  A trait that enum for op definitions that gathers up some shared functionality.
• validate
  Validation routines for instantiations of a extension ops and types in a Hugr.

Structs

• CustomValidator
  Encode a signature as PolyFuncType but optionally allow validating type arguments via a custom binary. The binary cannot be serialized so will be lost over a serialization round-trip.
• Extension
  A extension is a set of capabilities required to execute a graph.
• ExtensionRegistry
  Extension Registries store extensions to be looked up e.g. during validation.
• ExtensionSet
  A set of extensions identified by their unique ExtensionId.
• ExtensionValue
  A constant value provided by a extension. Must be an instance of a type available to the extension.
• Folder
  Type holding a boxed const-folding function.
• OpDef
  Serializable definition for dynamically loaded operations.
• TypeDef
  A declaration of an opaque type. Note this does not provide any way to create instances

Enums

• ExtensionBuildError
  An error that can occur in building a new extension.
• ExtensionRegistryError
  An error that can occur in defining an extension registry.
• InferExtensionError
  Errors which arise during unification
• LowerFunc
  Different ways that an OpDef can lower operation nodes i.e. provide a Hugr that implements the operation using a set of other extensions.
• SignatureError
  An error that can occur in computing the signature of a node. TODO: decide on failure modes
• SignatureFunc
  The two ways in which an OpDef may compute the Signature of each operation node.
• TypeDefBound
  The type bound of a TypeDef

Constants

• EMPTY_REG
  An Extension Registry containing no extensions.

Traits

• ConstFold
  Trait implemented by extension operations that can perform constant folding.
• CustomSignatureFunc
  Trait necessary for binary computations of OpDef signature
• SignatureFromArgs
  Compute signature of OpDef given type arguments.
• ValidateJustArgs
  Trait for validating type arguments to a PolyFuncType beyond conformation to declared type parameter (which should have been checked beforehand), given just the arguments.
• ValidateTypeArgs
  Trait for validating type arguments to a PolyFuncType beyond conformation to declared type parameter (which should have been checked beforehand).

Type Aliases

• ConstFoldResult
  Output of constant folding an operation, None indicates folding was either not possible or unsuccessful. An empty vector indicates folding was successful and no values are output.
• ExtensionId
  A unique identifier for a extension.
• ExtensionSolution
  A mapping from nodes on the hugr to extension requirement sets which have been inferred for their inputs.