Skip to main content

QqlError

Struct QqlError 

Source
pub struct QqlError {
    pub kind: ErrorKind,
    pub code: Cow<'static, str>,
    pub message: Cow<'static, str>,
    pub span: Option<Span>,
    pub fields: Vec<ErrorField>,
    pub source: Option<Box<QqlError>>,
}
Expand description

Unified error type for the entire QQL pipeline.

Every error carries:

  • a broad ErrorKind category,
  • a machine-readable code (e.g. QQL-EDGE-COLLECTION-NOT-FOUND),
  • a human-readable message,
  • an optional source-code Span,
  • optional structured ErrorFields for machine-readable context, and
  • an optional causal source error for chaining.

Fields§

§kind: ErrorKind

Broad origin category within the pipeline.

§code: Cow<'static, str>

Machine-readable error code, e.g. QQL-PARSE-SYNTAX.

§message: Cow<'static, str>

Human-readable description of the failure.

§span: Option<Span>

Optional source span in the original query text.

§fields: Vec<ErrorField>

Structured key-value metadata providing machine-readable context (e.g. collection, status_code, field_name, url).

§source: Option<Box<QqlError>>

Causal error that led to this one (error chaining).

Implementations§

Source§

impl QqlError

Source

pub fn new( kind: ErrorKind, code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, span: Option<Span>, ) -> Self

Build an error with an explicit kind, code, message, and optional span.

Source

pub fn lex( code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, span: Span, ) -> Self

Create an error with ErrorKind::Lex and the given source span.

Source

pub fn parse( code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, span: Span, ) -> Self

Create an error with ErrorKind::Parse and the given source span.

Source

pub fn validation( code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, span: Option<Span>, ) -> Self

Create an error with ErrorKind::Validation and an optional span.

Source

pub fn execution( code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, span: Option<Span>, ) -> Self

Create an error with ErrorKind::Execution and an optional span.

Source

pub fn transport( code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, span: Option<Span>, ) -> Self

Create an error with ErrorKind::Transport and an optional span.

Source

pub fn backend( code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, span: Option<Span>, ) -> Self

Create an error with ErrorKind::Backend and an optional span.

Source

pub fn with_field( self, key: impl Into<Cow<'static, str>>, value: impl Into<Cow<'static, str>>, ) -> Self

Attach a structured key-value metadata field.

let err = QqlError::backend("QQL-BACKEND", "unexpected status", None)
    .with_field("status_code", "404")
    .with_field("collection", "my_collection");
assert_eq!(err.field("status_code"), Some("404"));
assert_eq!(err.field("collection"), Some("my_collection"));
Source

pub fn with_collection(self, name: impl Into<Cow<'static, str>>) -> Self

Shorthand for .with_field("collection", name).

Source

pub fn with_status(self, code: u16) -> Self

Shorthand for .with_field("status_code", code).

Source

pub fn with_url(self, url: impl Into<Cow<'static, str>>) -> Self

Shorthand for .with_field("url", url).

Source

pub fn with_field_name(self, name: impl Into<Cow<'static, str>>) -> Self

Shorthand for .with_field("field_name", name).

Source

pub fn with_index_name(self, name: impl Into<Cow<'static, str>>) -> Self

Shorthand for .with_field("index_name", name).

Source

pub fn with_vector_name(self, name: impl Into<Cow<'static, str>>) -> Self

Shorthand for .with_field("vector_name", name).

Source

pub fn with_model(self, name: impl Into<Cow<'static, str>>) -> Self

Shorthand for .with_field("model", name).

Source

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

Attach an optional source-code span.

Source

pub fn caused_by(self, source: QqlError) -> Self

Chain a causal error.

The source error will be displayed when the outer error is printed and is accessible via std::error::Error::source.

Source

pub fn field(&self, key: &str) -> Option<&str>

Look up the first value for a given metadata key, case-insensitive.

Trait Implementations§

Source§

impl Clone for QqlError

Source§

fn clone(&self) -> QqlError

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QqlError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for QqlError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for QqlError

Source§

impl Error for QqlError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

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. Read more
Source§

impl PartialEq for QqlError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for QqlError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.