Enum EnvelopeError 

#[non_exhaustive]
pub enum EnvelopeError {
    MagicNumber {
        expected: [u8; 8],
        found: [u8; 8],
    },
    InvalidFormatDescriptor {
        descriptor: usize,
    },
    FormatUnsupported {
        format: EnvelopeFormat,
        feature: Option<&'static str>,
    },
    NonASCIIFormat {
        format: EnvelopeFormat,
    },
    ZstdUnsupported,
    ExpectedSingleHugr {
        count: usize,
    },
    SerdeError {
        source: Error,
    },
    IO {
        source: Error,
    },
    PackageEncoding {
        source: PackageEncodingError,
    },
    ModelImport {
        source: ImportError,
    },
    ModelRead {
        source: ReadError,
    },
    ModelWrite {
        source: WriteError,
    },
    ModelTextRead {
        source: ParseError,
    },
    ModelTextResolve {
        source: ResolveError,
    },
    ExtensionLoad {
        source: ExtensionRegistryLoadError,
    },
    FlagUnsupported {
        flag_ids: Vec<usize>,
    },
    ExtensionVersion {
        source: WithGenerator<ExtensionBreakingError>,
    },
}

Error type for envelope operations.

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.

MagicNumber

Bad magic number.

Fields

expected: [u8; 8]

The expected magic number.

See MAGIC_NUMBERS.

found: [u8; 8]

The magic number in the envelope.

InvalidFormatDescriptor

The specified payload format is invalid.

Fields

descriptor: usize

The unsupported format.

FormatUnsupported

The specified payload format is not supported.

Fields

format: EnvelopeFormat

The unsupported format.

feature: Option<&'static str>

Optionally, the feature required to support this format.

NonASCIIFormat

Not all envelope formats can be represented as ASCII.

This error is used when trying to store the envelope into a string.

Fields

format: EnvelopeFormat

The unsupported format.

ZstdUnsupported

Envelope encoding required zstd compression, but the feature is not enabled.

ExpectedSingleHugr

Expected the envelope to contain a single HUGR.

Fields

count: usize

The number of HUGRs in the package.

SerdeError

JSON serialization error.

Fields

source: Error

The source error.

IO

IO read/write error.

Fields

source: Error

The source error.

PackageEncoding

Error writing a json package to the payload.

Fields

source: PackageEncodingError

The source error.

ModelImport

Error importing a HUGR from a hugr-model payload.

Fields

source: ImportError

The source error.

ModelRead

Error reading a HUGR model payload.

Fields

source: ReadError

The source error.

ModelWrite

Error writing a HUGR model payload.

Fields

source: WriteError

The source error.

ModelTextRead

Error reading a HUGR model payload.

Fields

source: ParseError

The source error.

ModelTextResolve

Error reading a HUGR model payload.

Fields

source: ResolveError

The source error.

ExtensionLoad

Error reading a list of extensions from the envelope.

Fields

source: ExtensionRegistryLoadError

The source error.

FlagUnsupported

The specified payload format is not supported.

Fields

flag_ids: Vec<usize>

The unrecognized flag bits.

ExtensionVersion

Error raised while checking for breaking extension version mismatch.

Fields

source: WithGenerator<ExtensionBreakingError>

The source error.

Trait Implementations

impl Debug for EnvelopeError

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

Formats the value using the given formatter.

impl Display for EnvelopeError

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

Formats the value using the given formatter.

impl Error for EnvelopeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for EnvelopeError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for EnvelopeError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ExtensionRegistryLoadError> for EnvelopeError

fn from(source: ExtensionRegistryLoadError) -> Self

Converts to this type from the input type.

impl From<ImportError> for EnvelopeError

fn from(source: ImportError) -> Self

Converts to this type from the input type.

impl From<PackageEncodingError> for EnvelopeError

fn from(source: PackageEncodingError) -> Self

Converts to this type from the input type.

impl From<ParseError> for EnvelopeError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ReadError> for EnvelopeError

fn from(source: ReadError) -> Self

Converts to this type from the input type.

impl From<ResolveError> for EnvelopeError

fn from(source: ResolveError) -> Self

Converts to this type from the input type.

impl From<WithGenerator<ExtensionBreakingError>> for EnvelopeError

fn from(source: WithGenerator<ExtensionBreakingError>) -> Self

Converts to this type from the input type.

impl From<WriteError> for EnvelopeError

fn from(source: WriteError) -> Self

Converts to this type from the input type.