Enum GraphError 

#[non_exhaustive]
pub enum GraphError {
    Storage {
        source: Error,
        hint: Option<String>,
    },
    Serialization {
        context: String,
        source: String,
        hint: Option<String>,
    },
    Query(QueryError),
    NodeNotFound {
        id: NodeId,
        hint: Option<String>,
    },
    EdgeNotFound {
        src: NodeId,
        label: String,
        dst: NodeId,
        hint: Option<String>,
    },
    HasEdges {
        id: NodeId,
        hint: Option<String>,
    },
    Transaction {
        message: String,
        hint: Option<String>,
    },
    IndexAlreadyExists {
        label: String,
        properties: Vec<String>,
        hint: Option<String>,
    },
    IndexNotFound {
        label: String,
        properties: Vec<String>,
        hint: Option<String>,
    },
    InvalidIndexDefinition {
        reason: String,
        hint: Option<String>,
    },
    InvalidName {
        name: String,
        hint: Option<String>,
    },
    SizeLimit {
        what: String,
        limit: usize,
        actual: usize,
        hint: Option<String>,
    },
    SchemaMismatch {
        found: u64,
        supported: u64,
        hint: Option<String>,
    },
}

All errors returned by graphdblite.

Every variant (except Query, which delegates to QueryError’s own hint) carries a hint: Option<String> for actionable suggestions.

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.

Storage

Fields

source: Error

hint: Option<String>

Serialization

Fields

context: String

source: String

hint: Option<String>

Query(QueryError)

Cypher query processing error (parse/semantic/runtime).

NodeNotFound

Fields

id: NodeId

hint: Option<String>

EdgeNotFound

Fields

src: NodeId

label: String

dst: NodeId

hint: Option<String>

HasEdges

Fields

id: NodeId

hint: Option<String>

Transaction

Internal transaction / concurrency error.

Fields

message: String

hint: Option<String>

IndexAlreadyExists

Fields

label: String

properties: Vec<String>

hint: Option<String>

IndexNotFound

Fields

label: String

properties: Vec<String>

hint: Option<String>

InvalidIndexDefinition

Fields

reason: String

hint: Option<String>

InvalidName

Fields

name: String

hint: Option<String>

SizeLimit

Fields

what: String

limit: usize

actual: usize

hint: Option<String>

SchemaMismatch

Fields

found: u64

supported: u64

hint: Option<String>

Implementations

impl GraphError

pub fn syntax(message: impl Into<String>) -> Self

Convenience constructor for syntax errors at the parse phase.

pub fn semantic(message: impl Into<String>) -> Self

Convenience constructor for semantic errors at the analysis phase.

pub fn constraint(message: impl Into<String>) -> Self

Convenience constructor for runtime constraint violations.

pub fn type_error(phase: QueryPhase, message: impl Into<String>) -> Self

Convenience constructor for type errors.

pub fn argument(phase: QueryPhase, message: impl Into<String>) -> Self

Convenience constructor for argument errors (e.g. missing parameters).

pub fn undefined_variable(name: impl Display) -> Self

Reference to a name not bound in the current scope.

pub fn procedure_not_found(name: impl Display) -> Self

Procedure name not registered in the procedure registry.

pub fn invalid_argument_type( phase: QueryPhase, function: impl Display, got: impl Display, ) -> Self

Function called with a value of an unsupported type.

pub fn invalid_argument_value( phase: QueryPhase, function: impl Display, message: impl Display, ) -> Self

Value passed to a function is out of the supported range.

pub fn number_out_of_range( phase: QueryPhase, message: impl Into<String>, ) -> Self

Numeric overflow / value outside the representable range.

pub fn query( phase: QueryPhase, code: ErrorCode, message: impl Into<String>, ) -> Self

Lower-level builder for arbitrary query errors with a known code.

pub fn with_hint(self, hint: impl Into<String>) -> Self

Attach a hint to a query error in place. No-op for non-Query variants that already have a hint field — call the variant constructor with the hint instead.

pub fn with_code(self, code: ErrorCode) -> Self

Attach a structured code to a query error. No-op for non-Query variants.

pub fn with_span(self, span: Span) -> Self

Attach a source-text span to a query error. No-op for non-Query variants or for synthetic spans (planner-rewritten nodes).

pub fn serialization(context: impl Into<String>, source: impl Display) -> Self

Wrap an internal serialization failure with a context tag.

pub fn transaction(message: impl Into<String>) -> Self

Wrap an internal transaction failure.

Trait Implementations

impl Debug for GraphError

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

Formats the value using the given formatter.

impl Display for GraphError

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

Formats the value using the given formatter.

impl Error for GraphError

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<Error> for GraphError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<QueryError> for GraphError

fn from(error: QueryError) -> Self

Converts to this type from the input type.