Struct hugr_core::types::FunctionType

pub struct FunctionType {
    pub input: TypeRow,
    pub output: TypeRow,
    pub extension_reqs: ExtensionSet,
}

Describes the edges required to/from a node, and thus, also the type of a Graph. This includes both the concept of “signature” in the spec, and also the target (value) of a call (static).

Fields

input: TypeRow

Value inputs of the function.

output: TypeRow

Value outputs of the function.

extension_reqs: ExtensionSet

The extension requirements which are added by the operation

Implementations

impl FunctionType

pub fn with_extension_delta(self, rs: impl Into<ExtensionSet>) -> Self

Builder method, add extension_reqs to an FunctionType

impl FunctionType

pub fn is_empty(&self) -> bool

The number of wires in the signature.

impl FunctionType

pub fn new(input: impl Into<TypeRow>, output: impl Into<TypeRow>) -> Self

Create a new signature with specified inputs and outputs.

pub fn new_endo(linear: impl Into<TypeRow>) -> Self

Create a new signature with the same input and output types (signature of an endomorphic function).

pub fn port_type(&self, port: impl Into<Port>) -> Option<&Type>

Returns the type of a value Port. Returns None if the port is out of bounds.

pub fn in_port_type(&self, port: impl Into<IncomingPort>) -> Option<&Type>

Returns the type of a value input Port. Returns None if the port is out of bounds.

pub fn out_port_type(&self, port: impl Into<OutgoingPort>) -> Option<&Type>

Returns the type of a value output Port. Returns None if the port is out of bounds.

pub fn in_port_type_mut( &mut self, port: impl Into<IncomingPort>, ) -> Option<&mut Type>

Returns a mutable reference to the type of a value input Port. Returns None if the port is out of bounds.

pub fn out_port_type_mut( &mut self, port: impl Into<OutgoingPort>, ) -> Option<&mut Type>

Returns the type of a value output Port. Returns None if the port is out of bounds.

pub fn port_type_mut(&mut self, port: impl Into<Port>) -> Option<&mut Type>

Returns a mutable reference to the type of a value Port. Returns None if the port is out of bounds.

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

Returns the number of ports in the signature.

pub fn input_count(&self) -> usize

Returns the number of input ports in the signature.

pub fn output_count(&self) -> usize

Returns the number of output ports in the signature.

pub fn types(&self, dir: Direction) -> &[Type]

Returns a slice of the types for the given direction.

pub fn input_types(&self) -> &[Type]

Returns a slice of the input types.

pub fn output_types(&self) -> &[Type]

Returns a slice of the output types.

pub fn input(&self) -> &TypeRow

Returns the input row

pub fn output(&self) -> &TypeRow

Returns the output row

impl FunctionType

pub fn find_rowvar(&self) -> Option<(usize, TypeBound)>

If this FunctionType contains any row variables, return one.

pub fn ports(&self, dir: Direction) -> impl Iterator<Item = Port>

Returns the Ports in the signature for a given direction.

pub fn input_ports(&self) -> impl Iterator<Item = IncomingPort>

Returns the incoming Ports in the signature.

pub fn output_ports(&self) -> impl Iterator<Item = OutgoingPort>

Returns the outgoing Ports in the signature.

Trait Implementations

impl Clone for FunctionType

fn clone(&self) -> FunctionType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionType

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

Formats the value using the given formatter.

impl Default for FunctionType

fn default() -> FunctionType

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FunctionType

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

Formats the value using the given formatter.

impl From<FunctionType> for PolyFuncType

fn from(body: FunctionType) -> Self

Converts to this type from the input type.

impl From<FunctionType> for SignatureFunc

fn from(v: FunctionType) -> Self

Converts to this type from the input type.

impl PartialEq for FunctionType

fn eq(&self, other: &FunctionType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FunctionType

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<PolyFuncType> for FunctionType

type Error = Vec<TypeParam>

If the PolyFuncType is not a monomorphic FunctionType, fail with the binders

fn try_from(value: PolyFuncType) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for FunctionType

impl StructuralPartialEq for FunctionType