Enum EnvelopeFormat

#[non_exhaustive]
pub enum EnvelopeFormat {
    Model = 1,
    ModelWithExtensions = 2,
    ModelText = 40,
    ModelTextWithExtensions = 41,
    PackageJson = 63,
}

Encoded format of an envelope payload.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Model = 1

hugr-model v0 binary capnproto message.

ModelWithExtensions = 2

hugr-model v0 binary capnproto message followed by a json-encoded crate::extension::ExtensionRegistry.

This is a temporary format required until the model adds support for extensions.

ModelText = 40

Human-readable S-expression encoding using hugr_model::v0.

Uses a printable ascii value as the discriminant so the envelope can be read as text.

:caution: This format does not yet support extension encoding, so it should be avoided.

ModelTextWithExtensions = 41

Human-readable S-expression encoding using hugr_model::v0.

Uses a printable ascii value as the discriminant so the envelope can be read as text.

This is a temporary format required until the model adds support for extensions.

PackageJson = 63

Json-encoded crate::package::Package

Uses a printable ascii value as the discriminant so the envelope can be read as text.

Implementations

impl EnvelopeFormat

pub const fn from_repr(discriminant: usize) -> Option<EnvelopeFormat>

Try to create Self from the raw representation

impl EnvelopeFormat

pub fn model_version(self) -> Option<u32>

If the format is a model format, returns its version number.

pub fn ascii_printable(self) -> bool

Returns whether the encoding format is ASCII-printable.

If true, the encoded envelope can be read as text.

Trait Implementations

impl Clone for EnvelopeFormat

fn clone(&self) -> EnvelopeFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeFormat

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

Formats the value using the given formatter.

impl Default for EnvelopeFormat

fn default() -> EnvelopeFormat

Returns the “default value” for a type.

impl Display for EnvelopeFormat

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

Formats the value using the given formatter.

impl Hash for EnvelopeFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EnvelopeFormat

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

impl Eq for EnvelopeFormat

impl StructuralPartialEq for EnvelopeFormat