Enum Error 

#[non_exhaustive]
pub enum Error {
    Status {
        component: &'static str,
        code: i64,
        message: String,
    },
    InvalidArgument(String),
    AllocationFailed(&'static str),
    InvalidUtf8(Utf8Error),
    MissingNul,
}

Errors that can be returned by safe AOCL wrappers.

Each AOCL component has its own native error code conventions; this enum is the lowest common denominator. Component-specific modules layer their own typed errors on top where useful.

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.

Status

An AOCL routine returned a non-success status code.

Fields

component: &'static str

AOCL component that produced the error (e.g. "blas", "lapack").

code: i64

Native return code from the AOCL routine.

message: String

Human-readable interpretation when one is available.

InvalidArgument(String)

Invalid arguments passed by the caller (dimension mismatch, null buffer, etc.). These are detected client-side before invoking AOCL.

AllocationFailed(&'static str)

A memory allocation requested by AOCL failed.

InvalidUtf8(Utf8Error)

A C string returned by AOCL was not valid UTF-8.

MissingNul

A C string returned by AOCL was missing its NUL terminator within the inspected window.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

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

fn from(source: Utf8Error) -> Error

Converts to this type from the input type.