Struct CoreError 

pub struct CoreError {
    pub message: String,
    pub span: Option<Span>,
    pub help: Option<String>,
    pub source_id: SourceId,
}

An error produced while evaluating a Beamfile: an unknown variable, a type mismatch, an unresolvable built-in call, and so on. Carries the span of the offending source text (and, when a nearby valid name exists, help text) so it can be rendered the same way alba_syntax::Diagnostic renders parse errors.

span is None for the rare failure that is about the Beamfile without being in it — a beam named by whoever asked for the run, which has no declaration site. Underlining an arbitrary declaration in that case asserts a source position that is not where the mistake is.

Fields

message: String

span: Option<Span>

help: Option<String>

source_id: SourceId

Implementations

impl CoreError

pub fn with_source_id(self, source_id: SourceId) -> Self

Overrides this error’s source_id. Public (unlike CoreError::new and CoreError::with_help) because it’s meant for callers outside this crate: crate::eval_expr and crate::render_template are re-exported so the engine can render a beam’s run/env templates at schedule time, but by then loading has finished and there is no active [SourceIdScope] (that type is pub(crate)-only, scoped to this crate’s own loading) — every error they build defaults to [ROOT_SOURCE_ID] regardless of which file the beam actually came from. A schedule-time caller that has the beam on hand should correct that explicitly, e.g. render_template(&tpl, &scope).map_err(|e| e.with_source_id(beam.source)), rather than reaching into the (also-public) source_id field directly — this method is the one, documented, intentional place that’s meant to happen, as opposed to an ad hoc patch scattered at whichever call site happens to need it.

pub fn into_diagnostic(self) -> Diagnostic

Converts this error into a renderable alba_syntax::Diagnostic, mirroring alba_syntax::ParseError::into_diagnostic. source_id is dropped here — a caller (the CLI) resolves it against a crate::loader::SourceMap to find the path and source text alba_syntax::render_diagnostic needs, which this crate has no access to (a CoreError alone, without the SourceMap it was produced alongside, is not enough to render anything).

Trait Implementations

impl Clone for CoreError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoreError

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

Formats the value using the given formatter.

impl Display for CoreError

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

Formats the value using the given formatter.

impl Error for CoreError

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 PartialEq for CoreError

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CoreError