Enum Error 

#[non_exhaustive]
pub enum Error {
    Op {
        op: &'static str,
        at: Option<&'static Location<'static>>,
        kind: OpErrorKind,
    },
    OutOfMemory(usize),
    Backend(String),
    UnsupportedDevice(Device),
    Io(String),
    InvalidArgument(String),
}

Why an operation failed.

Array operations never return this directly: an invalid call yields a failed array that carries an Error::Op (the op’s name, the caller’s source location and the reason), and every array computed from it carries the same error. It surfaces as Err at the boundary: crate::Array::check, crate::Array::eval, crate::Array::item, crate::Array::to_vec, I/O and transforms. Errors that happen while evaluating (a GPU failure, memory exhausted) use the other 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.

Op

An array operation rejected its arguments when it was recorded.

Fields

op: &'static str

The public operation the caller invoked (MLX’s name).

at: Option<&'static Location<'static>>

Where the caller invoked it; None for an error built inside nuvec that no public operation has located (see Error::location).

kind: OpErrorKind

Why it failed.

OutOfMemory(usize)

Memory for this many bytes could not be allocated (or exceeds the memory limit).

Backend(String)

The GPU backend failed (for example, a command buffer error).

UnsupportedDevice(Device)

No backend is available for the device (the GPU without Metal).

Io(String)

Reading or writing a file failed.

InvalidArgument(String)

An argument of a boundary function (transforms, loaders) is invalid.

Implementations

impl Error

pub fn kind(&self) -> Option<&OpErrorKind>

The reason of an op error.

pub fn location(&self) -> Option<&'static Location<'static>>

Where the failing op was called, for op errors raised by a public operation.

pub fn is_oom(&self) -> bool

Whether memory ran out: Error::OutOfMemory, or an op error of kind OpErrorKind::OutOfMemory (an allocation that failed while an op was recorded).

pub fn op_name(&self) -> Option<&'static str>

The name of the failing op, for op errors.

Trait Implementations

impl Clone for Error

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 Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Eq for Error

impl Error for Error

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Error