Enum Error 

pub enum Error {
    General(String),
    BufferAllocationFailed {
        requested_bytes: usize,
        available_bytes: usize,
    },
    InvalidBufferHandle(usize),
    ShaderCompilationError {
        shader: String,
        message: String,
    },
    DispatchLimitExceeded {
        dispatch_size: usize,
        limit: usize,
    },
    GridIndexOutOfBounds {
        i: usize,
        j: usize,
        k: usize,
        nx: usize,
        ny: usize,
        nz: usize,
    },
    KernelArgCountMismatch {
        kernel: String,
        expected: usize,
        got: usize,
    },
    UnsupportedFeature {
        feature: String,
    },
}

Main error type for the gpu module.

Variants

General(String)

Generic error with a free-form message.

BufferAllocationFailed

A GPU buffer allocation failed.

Fields

requested_bytes: usize

Bytes requested.

available_bytes: usize

Bytes actually available.

InvalidBufferHandle(usize)

An invalid buffer handle was used.

ShaderCompilationError

A shader compilation error (mock).

Fields

shader: String

Name of the offending shader.

message: String

Compiler message.

DispatchLimitExceeded

A dispatch exceeded the hardware work-group limit.

Fields

dispatch_size: usize

Requested dispatch size (number of work-groups).

limit: usize

Hardware maximum.

GridIndexOutOfBounds

Out-of-bounds grid access.

Fields

i: usize

Requested x index.

j: usize

Requested y index.

k: usize

Requested z index.

nx: usize

Grid x dimension.

ny: usize

Grid y dimension.

nz: usize

Grid z dimension.

KernelArgCountMismatch

A kernel argument count mismatch.

Fields

kernel: String

Kernel name.

expected: usize

Expected number of arguments.

got: usize

Provided number of arguments.

UnsupportedFeature

An unsupported backend feature was requested.

Fields

feature: String

Description of the unsupported feature.

Implementations

impl Error

pub fn general(msg: impl Display) -> Self

Construct a Error::General from any Display-able value.

pub fn is_allocation_error(&self) -> bool

True when this is a recoverable allocation error.

pub fn is_shader_error(&self) -> bool

True when this is a shader compilation error.

pub fn is_grid_error(&self) -> bool

True when this is an out-of-bounds grid error.

pub fn is_arg_mismatch(&self) -> bool

True when this is a kernel argument mismatch error.

pub fn is_unsupported(&self) -> bool

True when this is an unsupported feature error.

pub fn in_stage(self, stage: impl Into<String>) -> PipelineStageError

Wrap this error in a PipelineStageError.

pub fn fatal(self, kernel: Option<&str>) -> AnnotatedError

Annotate with fatal severity.

pub fn warning(self, kernel: Option<&str>) -> AnnotatedError

Annotate with warning severity.

pub fn into_err<T>(self) -> Result<T>

Convert into a Result::Err.

Trait Implementations

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, __formatter: &mut Formatter<'_>) -> Result

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.