Enum CoreError 

#[non_exhaustive]
pub enum CoreError {
    InvalidConfig(String),
    ShapeMismatch {
        expected: Vec<usize>,
        actual: Vec<usize>,
    },
    DimensionMismatch {
        message: String,
    },
    DeviceNotAvailable {
        device: String,
    },
    DeviceMismatch,
    OutOfMemory {
        message: String,
    },
    KernelError {
        message: String,
    },
    NotImplemented {
        feature: String,
    },
    Io(String),
    Candle(Error),
}

Core errors shared across the rust-ai ecosystem.

These errors represent common failure modes that can occur in any crate. Domain-specific errors should wrap these variants.

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.

InvalidConfig(String)

Invalid configuration parameter.

Raised when a configuration value is out of bounds, incompatible, or otherwise invalid.

ShapeMismatch

Tensor shape mismatch.

Raised when an operation expects tensors of specific shapes but receives tensors with incompatible shapes.

Fields

expected: Vec<usize>

Expected shape.

actual: Vec<usize>

Actual shape received.

DimensionMismatch

Dimension count mismatch.

Raised when tensors have different numbers of dimensions.

Fields

message: String

Descriptive error message.

DeviceNotAvailable

Requested device not available.

Raised when attempting to use a device (e.g., CUDA:1) that doesn’t exist or isn’t accessible.

Fields

device: String

Description of the unavailable device.

DeviceMismatch

Device mismatch between tensors.

Raised when an operation requires tensors on the same device but they reside on different devices.

OutOfMemory

Out of memory.

Raised when GPU or CPU memory allocation fails.

Fields

message: String

Descriptive error message.

KernelError

GPU kernel error.

Raised when a CUDA/CubeCL kernel fails to launch or execute.

Fields

message: String

Descriptive error message.

NotImplemented

Feature not implemented.

Raised when a requested feature or code path is not yet implemented.

Fields

feature: String

Description of the unimplemented feature.

Io(String)

I/O error.

Raised for file operations, network errors, serialization failures, etc.

Candle(Error)

Underlying Candle error.

Wraps errors from the Candle tensor library.

Implementations

impl CoreError

pub fn invalid_config(msg: impl Into<String>) -> Self

Create an invalid configuration error.

pub fn shape_mismatch( expected: impl Into<Vec<usize>>, actual: impl Into<Vec<usize>>, ) -> Self

Create a shape mismatch error.

pub fn dim_mismatch(msg: impl Into<String>) -> Self

Create a dimension mismatch error.

pub fn device_not_available(device: impl Into<String>) -> Self

Create a device not available error.

pub fn oom(msg: impl Into<String>) -> Self

Create an out of memory error.

pub fn kernel(msg: impl Into<String>) -> Self

Create a kernel error.

pub fn not_implemented(feature: impl Into<String>) -> Self

Create a not implemented error.

pub fn io(msg: impl Into<String>) -> Self

Create an I/O error.

Trait Implementations

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 From<Error> for CoreError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for CoreError

fn from(err: Error) -> Self

Converts to this type from the input type.