Struct Package

pub struct Package {
    pub modules: Vec<Hugr>,
    pub extensions: ExtensionRegistry,
}

Package of module HUGRs.

Fields

modules: Vec<Hugr>

Module HUGRs included in the package.

extensions: ExtensionRegistry

Extensions used in the modules.

This is a superset of the extensions used in the modules.

Implementations

impl Package

pub fn new(modules: impl IntoIterator<Item = Hugr>) -> Self

Create a new package from a list of hugrs.

The hugr extensions are not automatically added to the package. Make sure to manually include any non-standard extensions to Package::extensions.

pub fn from_hugr(hugr: Hugr) -> Self

Create a new package containing a single HUGR.

The hugr extensions are not automatically added to the package. Make sure to manually include any non-standard extensions to Package::extensions.

pub fn validate(&self) -> Result<(), PackageValidationError>

Validate the modules of the package.

Ensures that the top-level extension list is a superset of the extensions used in the modules.

pub fn load( reader: impl BufRead, extensions: Option<&ExtensionRegistry>, ) -> Result<Self, EnvelopeError>

Read a Package from a HUGR envelope.

To load a Package, all the extensions used in its definition must be available. The Envelope may include some of the extensions, but any additional extensions must be provided in the extensions parameter. If extensions is None, the default crate::std_extensions::STD_REG is used.

pub fn load_str( envelope: impl AsRef<str>, extensions: Option<&ExtensionRegistry>, ) -> Result<Self, EnvelopeError>

Read a Package from a HUGR envelope encoded in a string.

Note that not all envelopes are valid strings. In the general case, it is recommended to use Package::load with a bytearray instead.

To load a Package, all the extensions used in its definition must be available. The Envelope may include some of the extensions, but any additional extensions must be provided in the extensions parameter. If extensions is None, the default crate::std_extensions::STD_REG is used.

pub fn store( &self, writer: impl Write, config: EnvelopeConfig, ) -> Result<(), EnvelopeError>

Store the Package in a HUGR envelope.

The Envelope will embed the definitions of the extensions in Package::extensions. Any other extension used in the definition must be passed to Package::load to load back the package.

pub fn store_str(&self, config: EnvelopeConfig) -> Result<String, EnvelopeError>

Store the Package in a HUGR envelope encoded in a string.

Note that not all envelopes are valid strings. In the general case, it is recommended to use Package::store with a bytearray instead. See EnvelopeFormat::ascii_printable.

The Envelope will embed the definitions of the extensions in Package::extensions. Any other extension used in the definition must be passed to Package::load_str to load back the package.

Trait Implementations

impl AsRef<[Hugr]> for Package

fn as_ref(&self) -> &[Hugr]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Package

fn clone(&self) -> Package

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Package

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

Formats the value using the given formatter.

impl Default for Package

fn default() -> Package

Returns the “default value” for a type.

impl<'de> DeserializeAs<'de, Package> for AsStringEnvelope

fn deserialize_as<D>(deserializer: D) -> Result<Package, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Package

fn eq(&self, other: &Package) -> 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 SerializeAs<Package> for AsStringEnvelope

fn serialize_as<S>(source: &Package, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Package