Enum EngineError 

#[non_exhaustive]
pub enum EngineError {
    Io(Error),
    Allocation {
        bytes: usize,
        align: usize,
        detail: String,
    },
    Device {
        backend: BackendKind,
        detail: String,
    },
    Execution(String),
    Plan(String),
    Format(String),
    Unsupported {
        feature: &'static str,
        detail: String,
    },
    Arrow(ArrowError),
    DataFusion(DataFusionError),
}

Errors produced by OxideLake library crates.

Binaries convert this into anyhow::Error; DataFusion boundaries convert it into DataFusionError::External via the provided From impl.

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.

Io(Error)

An operating-system or object-store I/O failure.

Allocation

A host or device allocation failed.

Fields

bytes: usize

Requested size in bytes.

align: usize

Requested alignment in bytes.

detail: String

Backend- or allocator-specific detail.

Device

A device or driver call failed.

Fields

backend: BackendKind

The backend that reported the failure.

detail: String

Driver- or runtime-specific detail.

Execution(String)

Operator execution failed.

Plan(String)

Planning or plan (de)serialization failed.

Format(String)

A file or stream is malformed (corrupt or truncated data).

Unsupported

The requested capability is not implemented on this path.

This is the only permitted “stub”: callers must be able to fall back or report the gap; panicking placeholders are forbidden.

Fields

feature: &'static str

Stable identifier of the missing capability, e.g. "metal.hash_join".

detail: String

Human-readable detail.

Arrow(ArrowError)

An Arrow error.

DataFusion(DataFusionError)

A DataFusion error.

Implementations

impl EngineError

pub fn unsupported(feature: &'static str, detail: impl Into<String>) -> Self

Builds an EngineError::Unsupported.

pub fn execution(detail: impl Into<String>) -> Self

Builds an EngineError::Execution.

pub fn plan(detail: impl Into<String>) -> Self

Builds an EngineError::Plan.

pub fn format(detail: impl Into<String>) -> Self

Builds an EngineError::Format.

pub fn device(backend: BackendKind, detail: impl Into<String>) -> Self

Builds an EngineError::Device.

pub fn allocation(bytes: usize, align: usize, detail: impl Into<String>) -> Self

Builds an EngineError::Allocation.

pub fn is_unsupported(&self) -> bool

Returns true for EngineError::Unsupported, the signal operators use to fall back to the CPU path.

Trait Implementations

impl Debug for EngineError

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

Formats the value using the given formatter.

impl Display for EngineError

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

Formats the value using the given formatter.

impl Error for EngineError

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<ArrowError> for EngineError

fn from(source: ArrowError) -> Self

Converts to this type from the input type.

impl From<DataFusionError> for EngineError

fn from(source: DataFusionError) -> Self

Converts to this type from the input type.

impl From<EngineError> for DataFusionError

fn from(err: EngineError) -> Self

Converts to this type from the input type.

impl From<Error> for EngineError

fn from(source: Error) -> Self

Converts to this type from the input type.