Struct FuncDecl

pub struct FuncDecl { /* private fields */ }

External function declaration, linked at runtime.

Implementations

impl FuncDecl

pub fn new(name: impl Into<String>, signature: impl Into<PolyFuncType>) -> Self

Create a new Visibility::Public instance with the given name and signature. See also Self::new_vis

pub fn new_vis( name: impl Into<String>, signature: impl Into<PolyFuncType>, visibility: Visibility, ) -> Self

Create a new instance with the given name, signature and visibility

pub fn func_name(&self) -> &String

The name of the function (not the name of the Op)

pub fn visibility(&self) -> &Visibility

The visibility of the function, e.g. for linking

pub fn func_name_mut(&mut self) -> &mut String

Allows mutating the name of the function (as per Self::func_name)

pub fn visibility_mut(&mut self) -> &mut Visibility

Allows mutating the Self::visibility of the function

pub fn signature(&self) -> &PolyFuncType

Gets the signature of the function

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

Allows mutating the signature of the function

Trait Implementations

impl Clone for FuncDecl

fn clone(&self) -> FuncDecl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FuncDecl

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FuncDecl

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FuncDecl> for OpType

fn from(v: FuncDecl) -> OpType

Converts to this type from the input type.

impl OpParent for FuncDecl

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

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

impl OpTrait for FuncDecl

fn description(&self) -> &'static str

A human-readable description of the operation.

fn tag(&self) -> OpTag

Tag identifying the operation.

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

The edge kind for a single constant output of the operation, not described by the dataflow signature.

fn try_node_handle<N, H>(&self, node: N) -> Option<H>

where N: HugrNode, H: NodeHandle<N> + From<N>,

Tries to create a specific NodeHandle for a node with this operation type.

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

The signature of the operation.

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

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

fn non_df_port_count(&self, dir: Direction) -> usize

Get the number of non-dataflow multiports.

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

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

impl PartialEq for FuncDecl

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StaticTag for FuncDecl

const TAG: OpTag = OpTag::Function

The name of the operation.

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

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

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValidateOp for FuncDecl

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 FuncDecl

impl StructuralPartialEq for FuncDecl