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>, ) -> Result<Self, PackageError>

Create a new package from a list of hugrs.

All the HUGRs must have a Module operation at the root.

Collects the extensions used in the modules and stores them in top-level extensions attribute.

Errors

Returns an error if any of the HUGRs does not have a Module root.

pub fn from_hugrs( modules: impl IntoIterator<Item = Hugr>, ) -> Result<Self, PackageError>

Create a new package from a list of hugrs.

HUGRs that do not have a Module root will be wrapped in a new Module root, depending on the root optype.

• Currently all non-module roots will raise PackageError::CannotWrapHugr.

Errors

Returns an error if any of the HUGRs cannot be wrapped in a module.

pub fn from_hugr(hugr: Hugr) -> Result<Self, PackageError>

Create a new package containing a single HUGR.

If the Hugr is not a module, a new OpType::Module root will be added. This behaviours depends on the root optype.

• Currently all non-module roots will raise PackageError::CannotWrapHugr.

Errors

Returns an error if the hugr cannot be wrapped in a module.

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.

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.

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

Store the Package in a HUGR envelope.

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.

pub fn from_json_reader( reader: impl Read, extension_registry: &ExtensionRegistry, ) -> Result<Self, PackageEncodingError>

👎Deprecated since 0.14.5: Json encoding of packages is deprecated. Use Package::load instead

Read a Package in json format from an io reader.

If the json encodes a single Hugr instead, it will be inserted in a new Package.

pub fn from_json( json: impl AsRef<str>, extension_registry: &ExtensionRegistry, ) -> Result<Self, PackageEncodingError>

👎Deprecated since 0.14.5: Json encoding of packages is deprecated. Use Package::load_str instead

Read a Package from a json string.

If the json encodes a single Hugr instead, it will be inserted in a new Package.

pub fn from_json_file( path: impl AsRef<Path>, extension_registry: &ExtensionRegistry, ) -> Result<Self, PackageEncodingError>

👎Deprecated since 0.14.5: Json encoding of packages is deprecated. Use Package::load instead

Read a Package from a json file.

If the json encodes a single Hugr instead, it will be inserted in a new Package.

pub fn to_json_writer( &self, writer: impl Write, ) -> Result<(), PackageEncodingError>

👎Deprecated since 0.14.5: Json encoding of packages is deprecated. Use Package::store instead

Write the Package in json format into an io writer.

pub fn to_json(&self) -> Result<String, PackageEncodingError>

👎Deprecated since 0.14.5: Json encoding of packages is deprecated. Use Package::store_str instead

Write the Package into a json string.

If the json encodes a single Hugr instead, it will be inserted in a new Package.

pub fn to_json_file( &self, path: impl AsRef<Path>, ) -> Result<(), PackageEncodingError>

👎Deprecated since 0.14.5: Json encoding of packages is deprecated. Use Package::store instead

Write the Package into a json file.

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 copy 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> Deserialize<'de> for Package

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __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 Serialize for Package

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 Package