Skip to main content

OptimError

optirs_tpu::error

Enum OptimError

#[non_exhaustive]pub enum OptimError {
Show 34 variants
    ComputationError(ErrorContext),
    DomainError(ErrorContext),
    DispatchError(ErrorContext),
    ConvergenceError(ErrorContext),
    DimensionError(ErrorContext),
    ShapeError(ErrorContext),
    IndexError(ErrorContext),
    ValueError(ErrorContext),
    TypeError(ErrorContext),
    NotImplementedError(ErrorContext),
    ImplementationError(ErrorContext),
    MemoryError(ErrorContext),
    AllocationError(ErrorContext),
    ConfigError(ErrorContext),
    InvalidArgument(ErrorContext),
    InvalidInput(ErrorContext),
    PermissionError(ErrorContext),
    ValidationError(ErrorContext),
    InvalidState(ErrorContext),
    JITError(ErrorContext),
    JSONError(ErrorContext),
    IoError(ErrorContext),
    SchedulerError(ErrorContext),
    TimeoutError(ErrorContext),
    CompressionError(ErrorContext),
    InvalidShape(ErrorContext),
    DeviceError(ErrorContext),
    MutexError(ErrorContext),
    ThreadError(ErrorContext),
    StreamError(ErrorContext),
    EndOfStream(ErrorContext),
    ResourceError(ErrorContext),
    CommunicationError(ErrorContext),
    SecurityError(ErrorContext),
}

Expand description

Core error type for SciRS2

This enum is #[non_exhaustive]: downstream crates must include a wildcard _ arm when matching on it, so that adding new variants here is not a breaking change. The core_error_non_exhaustive compile-fail test in scirs2-stability-tests guards this contract.

Variants (Non-exhaustive)§

This enum is marked as 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.

ComputationError(ErrorContext)

Computation error (generic error)

DomainError(ErrorContext)

Domain error (input outside valid domain)

DispatchError(ErrorContext)

Dispatch error (array protocol dispatch failed)

ConvergenceError(ErrorContext)

Convergence error (algorithm did not converge)

DimensionError(ErrorContext)

Dimension mismatch error

ShapeError(ErrorContext)

Shape error (matrices/arrays have incompatible shapes)

IndexError(ErrorContext)

Out of bounds error

ValueError(ErrorContext)

Value error (invalid value)

TypeError(ErrorContext)

Type error (invalid type)

NotImplementedError(ErrorContext)

Not implemented error

ImplementationError(ErrorContext)

Implementation error (method exists but not fully implemented yet)

MemoryError(ErrorContext)

Memory error (could not allocate memory)

AllocationError(ErrorContext)

Allocation error (memory allocation failed)

ConfigError(ErrorContext)

Configuration error (invalid configuration)

InvalidArgument(ErrorContext)

Invalid argument error

InvalidInput(ErrorContext)

Invalid input error

PermissionError(ErrorContext)

Permission error (insufficient permissions)

ValidationError(ErrorContext)

Validation error (input failed validation)

InvalidState(ErrorContext)

Invalid state error (object is in an invalid state)

JITError(ErrorContext)

JIT compilation error (error during JIT compilation)

JSONError(ErrorContext)

JSON error

IoError(ErrorContext)

IO error

SchedulerError(ErrorContext)

Scheduler error (error in work-stealing scheduler)

TimeoutError(ErrorContext)

Timeout error (operation timed out)

CompressionError(ErrorContext)

Compression error (error during compression/decompression)

InvalidShape(ErrorContext)

Invalid shape error (array shape is invalid)

DeviceError(ErrorContext)

Device error (GPU/hardware device error)

MutexError(ErrorContext)

Mutex error (mutex poisoning or lock error)

ThreadError(ErrorContext)

Thread error (threading error)

StreamError(ErrorContext)

Stream error (streaming operation error)

EndOfStream(ErrorContext)

End of stream error (stream ended unexpectedly)

ResourceError(ErrorContext)

Resource error (insufficient or unavailable resources)

CommunicationError(ErrorContext)

Communication error (network or inter-process communication error)

SecurityError(ErrorContext)

Security error (authentication, authorization, or security-related error)

Implementations§

impl CoreError

pub fn kind(&self) -> ErrorKind

Classify this error into an ErrorKind for programmatic matching.

pub fn error_message(&self) -> &str

Extract the error message string from the inner ErrorContext.

pub fn context(&self) -> &ErrorContext

Get the inner ErrorContext.

pub fn cause(&self) -> Option<&CoreError>

Return the chained cause, if any.

impl CoreError

Extension to CoreError for scheduler errors

pub fn schedulererror(message: &str) -> CoreError

Create a new scheduler error

Trait Implementations§

impl Clone for CoreError

fn clone(&self) -> CoreError

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

impl Debug for CoreError

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

Formats the value using the given formatter. Read more

impl Display for CoreError

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

Formats the value using the given formatter. Read more

impl Error for CoreError

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

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

impl From<ConversionError> for CoreError

fn from(err: ConversionError) -> CoreError

Converts to this type from the input type.

impl From<CoreError> for TpuError

fn from(source: OptimError) -> Self

Converts to this type from the input type.

impl From<CoreError> for ClockSynchronizationError

fn from(err: CoreError) -> Self

Converts to this type from the input type.

impl From<DistributedError> for CoreError

fn from(err: DistributedError) -> CoreError

Converts to this type from the input type.

impl From<Error> for CoreError

Convert from std::io::Error to CoreError

fn from(err: Error) -> CoreError

Converts to this type from the input type.

impl From<Error> for CoreError

Available on crate feature serialization only.

Convert from serde_json::Error to CoreError

fn from(err: Error) -> CoreError

Converts to this type from the input type.

impl From<Error> for CoreError

fn from(err: Error) -> CoreError

Converts to this type from the input type.

impl From<FromUtf8Error> for CoreError

fn from(err: FromUtf8Error) -> CoreError

Converts to this type from the input type.

impl From<GpuError> for CoreError

Convert GPU errors to core errors with semantic preservation

fn from(err: GpuError) -> CoreError

Converts to this type from the input type.

impl From<OperationError> for CoreError

Convert from OperationError to CoreError

fn from(err: OperationError) -> CoreError

Converts to this type from the input type.

impl From<ParseFloatError> for CoreError

fn from(err: ParseFloatError) -> CoreError

Converts to this type from the input type.

impl From<ParseIntError> for CoreError

fn from(err: ParseIntError) -> CoreError

Converts to this type from the input type.

impl<T> From<PoisonError<T>> for CoreError

fn from(err: PoisonError<T>) -> CoreError

Converts to this type from the input type.

impl From<String> for CoreError

Convert from String to CoreError (for parsing errors)

fn from(err: String) -> CoreError

Converts to this type from the input type.

impl From<SystemTimeError> for CoreError

fn from(err: SystemTimeError) -> CoreError

Converts to this type from the input type.

impl From<Utf8Error> for CoreError

fn from(err: Utf8Error) -> CoreError

Converts to this type from the input type.

Auto Trait Implementations§

impl Freeze for CoreError

impl RefUnwindSafe for CoreError

impl Send for CoreError

impl Sync for CoreError

impl Unpin for CoreError

impl UnsafeUnpin for CoreError

impl UnwindSafe for CoreError

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V