Enum brane_ast::compile::CompileResult

pub enum CompileResult {
    Workflow(Workflow, Vec<Warning>),
    Unresolved(UnresolvedWorkflow, Vec<Warning>),
    Program(Program, Vec<Warning>),
    Eof(Error),
    Err(Vec<Error>),
}

Defines the possible results returned by the compile_program function.

Variants

Workflow(Workflow, Vec<Warning>)

It’s a fully processed workflow, and a list of any warnings that occured during compilation.

Unresolved(UnresolvedWorkflow, Vec<Warning>)

It’s a workflow but not yet resolved to an executable one, and a list of any warnings that occured during compilation.

Program(Program, Vec<Warning>)

It’s a (possibly preprocessed) program still a,nd a list of any warnings that occured during compilation.

Eof(Error)

A very specific error has occurred that says that the parser (not the scanner) got an EOF before it was expecting it (i.e., it wants more input).

Err(Vec<Error>)

An (or rather, multiple) error(s) ha(s/ve) occurred.

Implementations

impl CompileResult

pub fn workflow(self) -> (Workflow, Vec<Warning>)

Force-unwraps the CompileResult as a fully compiled workflow (and any warnings that occurred), or else panics.

Returns

The carried Workflow and list of warnings as a tuple.

Panics

This function panics if it was not actually a workflow.

pub fn unresolved(self) -> (UnresolvedWorkflow, Vec<Warning>)

Force-unwraps the CompileResult as a compiled but unresolved workflow (and any warnings that occurred), or else panics.

Returns

The carried UnresolvedWorkflow and list of warnings as a tuple.

Panics

This function panics if it was not actually an unresolved workflow.

pub fn program(self) -> (Program, Vec<Warning>)

Force-unwraps the CompileResult as a (possibly preprocessed) Program (and any warnings that occurred), or else panics.

Returns

The carried Program and list of warnings as a tuple.

Panics

This function panics if it was not actually a program.

pub fn eof(self) -> Error

Force-unwraps the CompileResult as ‘not enough input’ (a special case of Error).

In whole-workflow files, this should be treated as a full error. However, in snippet cases, detecting this separately may allow them to query for more input instead.

Returns

The carried Error.

Panics

This function panics if it was not actually an end-of-file error.

pub fn err(self) -> Vec<Error>

Force-unwraps the CompileResult as an error.

Returns

The carried Error.

Panics

This function panics if it was not actually an error.

Trait Implementations

impl Debug for CompileResult

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

Formats the value using the given formatter.

impl Display for CompileResult

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

Formats the value using the given formatter.