Struct ModuleDesc 

pub struct ModuleDesc {
    pub num_nodes: Option<usize>,
    pub entrypoint: Option<Entrypoint>,
    pub used_extensions_resolved: Option<Vec<ExtensionDesc>>,
    pub generator: Option<String>,
    pub used_extensions_generator: Option<Vec<ExtensionDesc>>,
    pub public_symbols: Option<Vec<String>>,
}

High-level description of a module in a HUGR package.

Fields

num_nodes: Option<usize>

Number of nodes in the module.

entrypoint: Option<Entrypoint>

The entrypoint node and the corresponding operation type.

used_extensions_resolved: Option<Vec<ExtensionDesc>>

Extensions used in the module computed while resolving, expected to be a subset of used_extensions_generator.

generator: Option<String>

Generator specified in the module metadata.

used_extensions_generator: Option<Vec<ExtensionDesc>>

Generator specified used extensions in the module metadata.

public_symbols: Option<Vec<String>>

Public symbols defined in the module.

Implementations

impl ModuleDesc

pub fn set_num_nodes(&mut self, num_nodes: usize)

Sets the number of nodes in the module.

pub fn set_entrypoint(&mut self, node: Node, optype: OpType)

Sets the entrypoint of the module.

pub fn set_generator(&mut self, generator: impl Into<String>)

Sets the generator for the module.

pub fn set_used_extensions_generator( &mut self, used_extensions_metadata: impl IntoIterator<Item = ExtensionDesc>, )

Sets the extensions used by the generator in the module metadata.

pub fn extend_used_extensions_metadata( &mut self, exts: impl IntoIterator<Item = ExtensionDesc>, )

Extends the extensions used by the generator in the module metadata.

pub fn set_used_extensions_resolved( &mut self, used_extensions_resolved: impl IntoIterator<Item = ExtensionDesc>, )

Sets the resolved extensions used in the module.

pub fn extend_used_extensions_resolved( &mut self, exts: impl IntoIterator<Item = ExtensionDesc>, )

Extends the resolved extensions used in the module.

pub fn set_public_symbols(&mut self, symbols: impl IntoIterator<Item = String>)

Sets the public symbols defined in the module.

pub fn extend_public_symbols( &mut self, symbols: impl IntoIterator<Item = String>, )

Extends the public symbols defined in the module.

Trait Implementations

impl Clone for ModuleDesc

fn clone(&self) -> ModuleDesc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleDesc

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

Formats the value using the given formatter.

impl Default for ModuleDesc

fn default() -> ModuleDesc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ModuleDesc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<H: HugrView<Node = Node>> From<&H> for ModuleDesc

fn from(hugr: &H) -> Self

Converts to this type from the input type.

impl JsonSchema for ModuleDesc

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ModuleDesc

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModuleDesc