Enum GfError 

pub enum GfError {
    NotImplemented(&'static str),
    Parse {
        diagnostic: Option<Box<ParseError>>,
        msg: String,
        span: Span,
    },
    Bind {
        diagnostics: Vec<BindError>,
        msg: String,
        span: Span,
    },
    Lowering(LoweringError),
    LoweringExecution(LoweringError),
    BindPlan {
        msg: String,
        diagnostics: Vec<BindError>,
    },
    BindValidation {
        msg: String,
        diagnostics: Vec<BindError>,
    },
    Algorithm(AlgorithmError),
    Plan(String),
    Execution(String),
    Provider {
        class: String,
        provider: String,
        model: String,
    },
    Storage(String),
    Project {
        code: ProjectErrorCode,
        message: String,
    },
    Api {
        code: ApiErrorCode,
        message: String,
    },
    Lifecycle(String),
    Validation(String),
    Ontology(String),
}

Shared error classifications used by the engine facade and bindings.

Compiler stages, I/O, discovery, and other subsystems also expose dedicated error types. Boundary adapters classify them as needed; GfError::code supplies stable public codes rather than a one-to-one variant/exception map.

Variants

NotImplemented(&'static str)

Feature exists in the API but has not been implemented yet.

Parse

The Cypher parser rejected the input.

Fields

diagnostic: Option<Box<ParseError>>

Original typed parser diagnostic, when supplied by the parser.

msg: String

Human-readable description of the parse failure.

span: Span

Location of the bad token in the source.

Bind

The binder rejected the query (e.g. undeclared variable, strict-mode unknown label). Carries the source span of the first error so callers can point at the offending token; msg lists every binder error.

Publicly classified with GfError::Parse as GF_PARSE / ParseError — semantic query-structure failures share the parse fault domain.

Fields

diagnostics: Vec<BindError>

All original binder diagnostics, in their reported order.

msg: String

Human-readable description (all binder errors, joined with ; ).

span: Span

Source location of the first offending token.

Lowering(LoweringError)

A lowering failure with its original kind and payload.

LoweringExecution(LoweringError)

A lowering diagnostic discovered at an execution boundary. Keeps the established runtime fault domain rather than reclassifying it.

BindPlan

A legacy EXPLAIN binder rejection in the established planning domain.

Fields

msg: String

Existing public diagnostic.

diagnostics: Vec<BindError>

Complete original binder diagnostics.

BindValidation

A binder rejection in the established validation fault domain.

Fields

msg: String

Existing public diagnostic.

diagnostics: Vec<BindError>

Complete original binder diagnostics.

Algorithm(AlgorithmError)

An algorithm failure retaining its original kind and payload.

Plan(String)

The binder or query planner could not produce a valid plan.

Execution(String)

A runtime fault occurred during query execution.

Provider

A redacted configured-provider invocation failed.

Fields

class: String

Stable provider failure class.

provider: String

Normalized non-secret provider identifier.

model: String

Non-secret model identifier.

Storage(String)

A storage I/O operation failed.

Project

The project container cannot be resolved safely.

Fields

code: ProjectErrorCode

Stable public error code.

message: String

Safe diagnostic without participant contents or unrestricted paths.

Api

A structured knowledge/epistemic public API failure.

Fields

code: ApiErrorCode

Stable closed public error code.

message: String

Safe diagnostic without record contents.

Lifecycle(String)

An operation was invalid for the current instance lifecycle state.

Validation(String)

Input failed validation at the API boundary.

Ontology(String)

An ontology file could not be loaded or applied.

Implementations

impl GfError

pub fn from_plan_error(error: impl Error + 'static) -> Self

Preserve a GraphForge source when a planner wraps it in another error.

Foreign failures without a GraphForge source retain the existing GF_PLAN classification and diagnostic. Source traversal uses Rust’s error identity, never diagnostic text.

pub fn from_execution_error(error: impl Error + 'static) -> Self

Preserve a GraphForge source when execution wraps it in another error.

This also handles shared foreign errors: cloning the GraphForge value retains its typed code, variant, message, and source span without needing exclusive ownership of an upstream error. Foreign failures without a GraphForge source retain GF_EXECUTION and their existing diagnostic.

impl GfError

pub fn from_parse_display(error: ParseError) -> Self

Preserve the legacy EXPLAIN display while retaining the full parser diagnostic.

pub fn from_bind_plan_errors(errors: &[BindError]) -> Self

Preserve legacy cypher EXPLAIN’s planning domain and message.

pub fn from_bind_errors(errors: &[BindError]) -> Self

Preserve every binder diagnostic and the established primary span/message.

impl GfError

pub const fn code(&self) -> &'static str

Return the stable public error code for this failure.

Trait Implementations

impl Clone for GfError

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 GfError

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

Formats the value using the given formatter.

impl Display for GfError

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

Formats the value using the given formatter.

impl Error for GfError

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<AlgorithmError> for GfError

fn from(error: AlgorithmError) -> Self

Converts to this type from the input type.

impl From<GfError> for PortableV2Error

fn from(_: GfError) -> Self

Converts to this type from the input type.

impl From<LoweringError> for GfError

fn from(error: LoweringError) -> Self

Converts to this type from the input type.

impl From<ParseError> for GfError

fn from(error: ParseError) -> Self

Converts to this type from the input type.