Struct Extension

pub struct Extension {
    pub version: Version,
    pub name: ExtensionId,
    pub extension_reqs: ExtensionSet,
    /* private fields */
}

A extension is a set of capabilities required to execute a graph.

Fields

version: Version

Extension version, follows semver.

name: ExtensionId

Unique identifier for the extension.

extension_reqs: ExtensionSet

Other extensions defining types used by this extension. That is, an upper-bound on the types that can be returned by computing the signature of any operation in this extension, for any possible TypeArg.

Implementations

impl Extension

pub fn add_op( &mut self, name: OpName, description: String, signature_func: impl Into<SignatureFunc>, ) -> Result<&mut OpDef, ExtensionBuildError>

Add an operation definition to the extension. Must be a type scheme (defined by a PolyFuncTypeRV), a type scheme along with binary validation for type arguments (CustomValidator), or a custom binary function for computing the signature given type arguments (impl [CustomSignatureFunc]).

impl Extension

pub fn add_type( &mut self, name: TypeName, params: Vec<TypeParam>, description: String, bound: TypeDefBound, ) -> Result<&TypeDef, ExtensionBuildError>

Add an exported type to the extension.

impl Extension

pub fn new(name: ExtensionId, version: Version) -> Self

Creates a new extension with the given name.

pub fn with_reqs(self, extension_reqs: impl Into<ExtensionSet>) -> Self

Extend the requirements of this extension with another set of extensions.

pub fn get_op(&self, name: &OpNameRef) -> Option<&Arc<OpDef>>

Allows read-only access to the operations in this Extension

pub fn get_type(&self, type_name: &TypeNameRef) -> Option<&TypeDef>

Allows read-only access to the types in this Extension

pub fn get_value(&self, value_name: &ValueNameRef) -> Option<&ExtensionValue>

Allows read-only access to the values in this Extension

pub fn name(&self) -> &ExtensionId

Returns the name of the extension.

pub fn version(&self) -> &Version

Returns the version of the extension.

pub fn operations(&self) -> impl Iterator<Item = (&OpName, &Arc<OpDef>)>

Iterator over the operations of this Extension.

pub fn types(&self) -> impl Iterator<Item = (&TypeName, &TypeDef)>

Iterator over the types of this Extension.

pub fn add_value( &mut self, name: impl Into<ValueName>, typed_value: Value, ) -> Result<&mut ExtensionValue, ExtensionBuildError>

Add a named static value to the extension.

pub fn instantiate_extension_op( &self, name: &OpNameRef, args: impl Into<Vec<TypeArg>>, ext_reg: &ExtensionRegistry, ) -> Result<ExtensionOp, SignatureError>

Instantiate an ExtensionOp which references an OpDef in this extension.

Trait Implementations

impl Clone for Extension

fn clone(&self) -> Extension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Extension

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Extension

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Extension

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 Extension

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

where __S: Serializer,

Serialize this value into the given Serde serializer.