Enum AssemblyError

#[non_exhaustive]
pub enum AssemblyError {
    Empty,
    Failed {
        labels: Vec<RelatedLabel>,
    },
    Cycle {
        nodes: Vec<String>,
    },
    ConflictingDefinitions {
        first: QualifiedProcedureName,
        second: QualifiedProcedureName,
    },
    DuplicateModule {
        path: LibraryPath,
    },
    UndefinedModule {
        span: SourceSpan,
        source_file: Option<Arc<SourceFile>>,
        path: LibraryPath,
    },
    InconsistentNamespace {
        expected: LibraryNamespace,
        actual: LibraryNamespace,
    },
    InvalidSysCallTarget {
        span: SourceSpan,
        source_file: Option<Arc<SourceFile>>,
        callee: QualifiedProcedureName,
    },
    InvalidLocalWordIndex {
        span: SourceSpan,
        source_file: Option<Arc<SourceFile>>,
        local_addr: u16,
    },
    CallerOutsideOfKernel {
        span: SourceSpan,
        source_file: Option<Arc<SourceFile>>,
    },
    EmptyProcedureBodyWithDecorators {
        span: SourceSpan,
        source_file: Option<Arc<SourceFile>>,
    },
    Other(RelatedError),
    Forest(&'static str, MastForestError),
}

An error which can be generated while compiling a Miden assembly program into a MAST.

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.

Empty

Failed

Fields

labels: Vec<RelatedLabel>

Cycle

Fields

nodes: Vec<String>

ConflictingDefinitions

Fields

first: QualifiedProcedureName

second: QualifiedProcedureName

DuplicateModule

Fields

path: LibraryPath

UndefinedModule

Fields

span: SourceSpan

source_file: Option<Arc<SourceFile>>

path: LibraryPath

InconsistentNamespace

Fields

expected: LibraryNamespace

actual: LibraryNamespace

InvalidSysCallTarget

Fields

span: SourceSpan

source_file: Option<Arc<SourceFile>>

callee: QualifiedProcedureName

InvalidLocalWordIndex

Fields

span: SourceSpan

source_file: Option<Arc<SourceFile>>

local_addr: u16

CallerOutsideOfKernel

Fields

span: SourceSpan

source_file: Option<Arc<SourceFile>>

EmptyProcedureBodyWithDecorators

Fields

span: SourceSpan

source_file: Option<Arc<SourceFile>>

Other(RelatedError)

Forest(&'static str, MastForestError)

Trait Implementations

impl Debug for AssemblyError

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

Formats the value using the given formatter.

impl Diagnostic for AssemblyError

fn code(&self) -> Option<Box<dyn Display + '_>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn help(&self) -> Option<Box<dyn Display + '_>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn related(&self) -> Option<Box<dyn Iterator<Item = &dyn Diagnostic> + '_>>

Additional related Diagnostics.

fn url(&self) -> Option<Box<dyn Display + '_>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl Display for AssemblyError

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

Formats the value using the given formatter.

impl Error for AssemblyError

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.