Enum ParseError 

#[non_exhaustive]
pub enum ParseError {
    Syntax {
        message: String,
        span: Span,
    },
    UndefinedId {
        id: u32,
        span: Span,
    },
    DuplicateId {
        id: u32,
        span: Span,
    },
    DuplicateBranchName {
        name: String,
        span: Span,
    },
    UndefinedBranchName {
        name: String,
        span: Span,
    },
    InvalidDirection {
        from: IVec3,
        to: IVec3,
        span: Span,
        message: String,
    },
    InvalidWalkingBlock {
        start: IVec3,
        end: IVec3,
        span: Span,
        message: String,
    },
    InvalidPatchRotationBlock {
        start: IVec3,
        end: IVec3,
        span: Span,
        message: String,
    },
    CoordinateOverflow {
        span: Span,
        message: String,
    },
    ConflictingCubeHeights {
        pos: IVec3,
        height: CubeHeight,
        other_pos: IVec3,
        other_height: CubeHeight,
        span: Span,
    },
    UnsupportedVersion {
        major: u32,
        minor: u32,
        span: Span,
    },
    Graph {
        source: Box<BlockGraphError>,
        span: Option<Span>,
    },
}

An error from parsing or lowering .blog source text.

Most variants carry a Span into the source for diagnostic rendering; see ParseError::render_diagnostic.

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.

Syntax

Source text does not satisfy BLOG grammar.

Fields

message: String

Parser diagnostic.

span: Span

Source range containing the syntax error.

UndefinedId

A statement references an undeclared block ID.

Fields

id: u32

Missing block ID.

span: Span

Source range containing the reference.

DuplicateId

A block ID is declared more than once.

Fields

id: u32

Repeated block ID.

span: Span

Source range containing the duplicate declaration.

DuplicateBranchName

A branch region name is declared more than once.

Fields

name: String

Repeated branch name.

span: Span

Source range containing the duplicate declaration.

UndefinedBranchName

An action references an undeclared branch region.

Fields

name: String

Missing branch name.

span: Span

Source range containing the reference.

InvalidDirection

Two pipe endpoints do not define a supported direction.

Fields

from: IVec3

First endpoint.

to: IVec3

Second endpoint.

span: Span

Source range containing the pipe.

message: String

Direction validation diagnostic.

InvalidWalkingBlock

A walking block has invalid endpoints or boundary data.

Fields

start: IVec3

Starting lattice position.

end: IVec3

Ending lattice position.

span: Span

Source range containing the block.

message: String

Walking-block validation diagnostic.

InvalidPatchRotationBlock

A patch-rotation block has invalid endpoints or basis data.

Fields

start: IVec3

Starting lattice position.

end: IVec3

Ending lattice position.

span: Span

Source range containing the block.

message: String

Patch-rotation validation diagnostic.

CoordinateOverflow

Coordinate arithmetic overflowed during lowering.

Fields

span: Span

Source range whose lowering overflowed.

message: String

Overflow diagnostic.

ConflictingCubeHeights

Spatially connected cubes specify different symbolic heights.

Fields

pos: IVec3

Position of the first conflicting cube.

height: CubeHeight

Height of the first conflicting cube.

other_pos: IVec3

Position of the second conflicting cube.

other_height: CubeHeight

Height of the second conflicting cube.

span: Span

Source range containing the conflict.

UnsupportedVersion

The source declares a BLOG version this parser does not support.

Fields

major: u32

Declared major version.

minor: u32

Declared minor version.

span: Span

Source range containing the version declaration.

Graph

A graph-construction or action-list failure raised while lowering the parsed AST into a BlockGraph.

When present, span points at the source statement that introduced the invalid graph element — the block or pipe statement whose lowering the graph rejected. It is None when no single statement is responsible (e.g. action-list validation).

Fields

source: Box<BlockGraphError>

Underlying graph-construction failure.

span: Option<Span>

Source statement responsible for the failure, when known.

Implementations

impl ParseError

pub fn span(&self) -> Option<Span>

Source span for diagnostic rendering (if available).

pub fn render_diagnostic(&self, filename: &str, source: &str) -> String

Render a rustc-style diagnostic using ariadne, with ANSI colors for terminal display.

pub fn render_diagnostic_plain(&self, filename: &str, source: &str) -> String

Render the same diagnostic as render_diagnostic but without ANSI escape sequences, for non-terminal consumers (exception messages, logs, files).

Trait Implementations

impl Clone for ParseError

fn clone(&self) -> ParseError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

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<ParseError> for ModuleError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseError> for BlockGraphError

fn from(source: ParseError) -> Self

Converts to this type from the input type.