Skip to main content

MlError

Enum MlError 

Source
pub enum MlError {
    DeviceUnavailable(String),
    FeatureDisabled(&'static str),
    ModelLoad {
        path: PathBuf,
        reason: String,
    },
    InvalidInput(String),
    Preprocess(String),
    Postprocess(String),
    Pipeline {
        stage: &'static str,
        message: String,
    },
    CacheCapacityZero,
    OnnxRuntime(String),
}
Expand description

Errors surfaced by oximedia-ml.

Construct user-facing failures with MlError::invalid_input, MlError::preprocess, MlError::postprocess, or MlError::pipeline; the remaining variants are usually produced by the crate itself and matched on at call sites.

Variants§

§

DeviceUnavailable(String)

The requested device is either unknown, unavailable, or built without its feature flag.

§

FeatureDisabled(&'static str)

A feature required to perform the operation is disabled.

§

ModelLoad

The model file could not be loaded from disk.

Fields

§path: PathBuf

Model path that failed to load.

§reason: String

Human-readable reason provided by the backend.

§

InvalidInput(String)

Input tensor(s) did not match the model’s contract.

§

Preprocess(String)

Pre-processing failed (e.g. image dimensions don’t fit).

§

Postprocess(String)

Post-processing failed (e.g. reading an output tensor).

§

Pipeline

A pipeline sub-component failed to execute.

Fields

§stage: &'static str

Pipeline stage that raised the error.

§message: String

Descriptive error message.

§

CacheCapacityZero

The cache capacity was zero, which is invalid.

§

OnnxRuntime(String)

Underlying ONNX runtime error (feature-gated).

Implementations§

Source§

impl MlError

Source

pub fn pipeline(stage: &'static str, message: impl Into<String>) -> Self

Convenience constructor for pipeline errors.

Source

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

Convenience constructor for invalid input errors.

Source

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

Convenience constructor for preprocess errors.

Source

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

Convenience constructor for postprocess errors.

Trait Implementations§

Source§

impl Debug for MlError

Source§

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

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

impl Display for MlError

Source§

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

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

impl Error for MlError

1.30.0 · 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

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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<E> OxiErrorExt for E
where E: Error,

Source§

fn with_oxi_context(self, frame: ErrorFrame) -> OxiError

Wraps self by prepending the frame’s display string as context.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.