Struct PackageDesc 

pub struct PackageDesc {
    pub header: EnvelopeHeader,
    pub modules: Vec<Option<ModuleDesc>>,
    pub packaged_extensions: Vec<Option<ExtensionDesc>>,
}

High-level description of a HUGR package.

Fields

header: EnvelopeHeader

Envelope header information.

modules: Vec<Option<ModuleDesc>>

Description of the modules in the package.

packaged_extensions: Vec<Option<ExtensionDesc>>

Description of the extensions in the package.

Implementations

impl PackageDesc

pub fn header(&self) -> EnvelopeHeader

Returns the package header.

pub fn n_modules(&self) -> usize

Returns the number of modules in the package.

pub fn n_packaged_extensions(&self) -> usize

Returns the number of packaged extensions in the package.

pub fn generator(&self) -> Option<String>

Returns the generator(s) of the package modules, if any. Concatenates multiple generators with commas.

pub fn modules(&self) -> impl Iterator<Item = &Option<ModuleDesc>>

Returns an iterator over the module descriptions. Modules with expected but missing descriptions yield None.

pub fn packaged_extensions(&self) -> impl Iterator<Item = &ExtensionDesc>

Returns an iterator over the packaged extension descriptions. Missing extensions are skipped.

Trait Implementations

impl Clone for PackageDesc

fn clone(&self) -> PackageDesc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageDesc

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

Formats the value using the given formatter.

impl Default for PackageDesc

fn default() -> PackageDesc

Returns the “default value” for a type.

impl JsonSchema for PackageDesc

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 PackageDesc

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

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 PackageDesc