pub struct Extension {
pub version: Version,
pub name: ExtensionId,
/* private fields */
}
Expand description
A extension is a set of capabilities required to execute a graph.
These are normally defined once and shared across multiple graphs and
operations wrapped in Arc
s inside ExtensionRegistry
.
§Example
The following example demonstrates how to define a new extension with a custom operation and a custom type.
When using arc
s, the extension can only be modified at creation time. The
defined operations and types keep a Weak
reference to their extension. We provide a
helper method Extension::new_arc
to aid their definition.
Extension::new_arc(
ExtensionId::new_unchecked("my.extension"),
Version::new(0, 1, 0),
|ext, extension_ref| {
// Add a custom type definition
ext.add_type(
"MyType".into(),
vec![], // No type parameters
"Some type".into(),
TypeDefBound::any(),
extension_ref,
);
// Add a custom operation
ext.add_op(
"MyOp".into(),
"Some operation".into(),
Signature::new_endo(vec![]),
extension_ref,
);
},
);
Fields§
§version: Version
Extension version, follows semver.
name: ExtensionId
Unique identifier for the extension.
Implementations§
Source§impl Extension
impl Extension
Sourcepub fn add_op(
&mut self,
name: OpName,
description: String,
signature_func: impl Into<SignatureFunc>,
extension_ref: &Weak<Extension>,
) -> Result<&mut OpDef, ExtensionBuildError>
pub fn add_op( &mut self, name: OpName, description: String, signature_func: impl Into<SignatureFunc>, extension_ref: &Weak<Extension>, ) -> 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 (implementing
[CustomSignatureFunc]
).
This method requires a Weak
reference to the Arc
containing the
extension being defined. The intended way to call this method is inside
the closure passed to Extension::new_arc
when defining the extension.
§Example
Extension::new_arc(
ExtensionId::new_unchecked("my.extension"),
Version::new(0, 1, 0),
|ext, extension_ref| {
ext.add_op(
"MyOp".into(),
"Some operation".into(),
Signature::new_endo(vec![]),
extension_ref,
);
},
);
Source§impl Extension
impl Extension
Sourcepub fn add_type(
&mut self,
name: TypeName,
params: Vec<TypeParam>,
description: String,
bound: TypeDefBound,
extension_ref: &Weak<Extension>,
) -> Result<&TypeDef, ExtensionBuildError>
pub fn add_type( &mut self, name: TypeName, params: Vec<TypeParam>, description: String, bound: TypeDefBound, extension_ref: &Weak<Extension>, ) -> Result<&TypeDef, ExtensionBuildError>
Add an exported type to the extension.
This method requires a Weak
reference to the std::sync::Arc
containing the
extension being defined. The intended way to call this method is inside
the closure passed to Extension::new_arc
when defining the extension.
§Example
Extension::new_arc(
ExtensionId::new_unchecked("my.extension"),
Version::new(0, 1, 0),
|ext, extension_ref| {
ext.add_type(
"MyType".into(),
vec![], // No type parameters
"Some type".into(),
TypeDefBound::any(),
extension_ref,
);
},
);
Source§impl Extension
impl Extension
Sourcepub fn new(name: ExtensionId, version: Version) -> Self
pub fn new(name: ExtensionId, version: Version) -> Self
Creates a new extension with the given name.
In most cases extensions are contained inside an Arc
so that they
can be shared across hugr instances and operation definitions.
See Extension::new_arc
for a more ergonomic way to create boxed
extensions.
Sourcepub fn new_arc(
name: ExtensionId,
version: Version,
init: impl FnOnce(&mut Extension, &Weak<Extension>),
) -> Arc<Self>
pub fn new_arc( name: ExtensionId, version: Version, init: impl FnOnce(&mut Extension, &Weak<Extension>), ) -> Arc<Self>
Creates a new extension wrapped in an Arc
.
The closure lets us use a weak reference to the arc while the extension
is being built. This is necessary for calling Extension::add_op
and
Extension::add_type
.
Sourcepub fn try_new_arc<E>(
name: ExtensionId,
version: Version,
init: impl FnOnce(&mut Extension, &Weak<Extension>) -> Result<(), E>,
) -> Result<Arc<Self>, E>
pub fn try_new_arc<E>( name: ExtensionId, version: Version, init: impl FnOnce(&mut Extension, &Weak<Extension>) -> Result<(), E>, ) -> Result<Arc<Self>, E>
Creates a new extension wrapped in an Arc
, using a fallible
initialization function.
The closure lets us use a weak reference to the arc while the extension
is being built. This is necessary for calling Extension::add_op
and
Extension::add_type
.
Sourcepub fn get_op(&self, name: &OpNameRef) -> Option<&Arc<OpDef>>
pub fn get_op(&self, name: &OpNameRef) -> Option<&Arc<OpDef>>
Allows read-only access to the operations in this Extension
Sourcepub fn get_type(&self, type_name: &TypeNameRef) -> Option<&TypeDef>
pub fn get_type(&self, type_name: &TypeNameRef) -> Option<&TypeDef>
Allows read-only access to the types in this Extension
Sourcepub fn name(&self) -> &ExtensionId
pub fn name(&self) -> &ExtensionId
Returns the name of the extension.
Sourcepub fn operations(&self) -> impl Iterator<Item = (&OpName, &Arc<OpDef>)>
pub fn operations(&self) -> impl Iterator<Item = (&OpName, &Arc<OpDef>)>
Iterator over the operations of this Extension
.
Sourcepub fn types(&self) -> impl Iterator<Item = (&TypeName, &TypeDef)>
pub fn types(&self) -> impl Iterator<Item = (&TypeName, &TypeDef)>
Iterator over the types of this Extension
.
Sourcepub fn instantiate_extension_op(
&self,
name: &OpNameRef,
args: impl Into<Vec<TypeArg>>,
) -> Result<ExtensionOp, SignatureError>
pub fn instantiate_extension_op( &self, name: &OpNameRef, args: impl Into<Vec<TypeArg>>, ) -> Result<ExtensionOp, SignatureError>
Instantiate an ExtensionOp
which references an OpDef
in this extension.
Trait Implementations§
Source§impl<'de> Deserialize<'de> for Extension
impl<'de> Deserialize<'de> for Extension
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for Extension
impl !RefUnwindSafe for Extension
impl Send for Extension
impl Sync for Extension
impl Unpin for Extension
impl !UnwindSafe for Extension
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Serialize for T
impl<T> Serialize for T
fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>
fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.