Enum ImgalError 

pub enum ImgalError {
    InvalidAxis {
        axis_idx: usize,
        dim_len: usize,
    },
    InvalidAxisLengthLess {
        arr_name: &'static str,
        axis_idx: usize,
        value: usize,
    },
    InvalidAxisLengthExpected {
        arr_name: &'static str,
        axis_idx: usize,
        expected: usize,
        got: usize,
    },
    InvalidArrayLengthExpected {
        arr_name: &'static str,
        expected: usize,
        got: usize,
    },
    InvalidArrayLengthMinimum {
        arr_name: &'static str,
        arr_len: usize,
        min_len: usize,
    },
    InvalidAxisValueGreaterEqual {
        arr_name: &'static str,
        axis_idx: usize,
        value: usize,
    },
    InvalidAxisValueNotAMultipleOf {
        arr_name: &'static str,
        axis_idx: usize,
        multiple: usize,
    },
    InvalidGeneric {
        msg: &'static str,
    },
    InvalidParameterEmptyArray {
        param_name: &'static str,
    },
    InvalidParameterGreater {
        a_param_name: &'static str,
        b_param_name: &'static str,
    },
    InvalidParameterValueEqual {
        param_name: &'static str,
        value: usize,
    },
    InvalidParameterValueGreater {
        param_name: &'static str,
        value: usize,
    },
    InvalidParameterValueLess {
        param_name: &'static str,
        value: usize,
    },
    InvalidParameterValueOutsideRange {
        param_name: &'static str,
        value: f64,
        min: f64,
        max: f64,
    },
    InvalidPositiveRange {
        start: usize,
        end: usize,
    },
    InvalidSum {
        expected: f64,
        got: f64,
    },
    MismatchedArrayLengths {
        a_arr_name: &'static str,
        a_arr_len: usize,
        b_arr_name: &'static str,
        b_arr_len: usize,
    },
    MismatchedArrayShapes {
        a_arr_name: &'static str,
        a_shape: Vec<usize>,
        b_arr_name: &'static str,
        b_shape: Vec<usize>,
    },
    MismatchedDimensionLengths {
        a_name: &'static str,
        a_dim_len: usize,
        b_name: &'static str,
        b_dim_len: usize,
    },
}

Image and function parameter validation errors.

ImgalError is used to return errors when validating array shapes, lengths and parameter values.

Variants

InvalidAxis

Fields

axis_idx: usize

dim_len: usize

InvalidAxisLengthLess

Fields

arr_name: &'static str

axis_idx: usize

value: usize

InvalidAxisLengthExpected

Fields

arr_name: &'static str

axis_idx: usize

expected: usize

got: usize

InvalidArrayLengthExpected

Fields

arr_name: &'static str

expected: usize

got: usize

InvalidArrayLengthMinimum

Fields

arr_name: &'static str

arr_len: usize

min_len: usize

InvalidAxisValueGreaterEqual

Fields

arr_name: &'static str

axis_idx: usize

value: usize

InvalidAxisValueNotAMultipleOf

Fields

arr_name: &'static str

axis_idx: usize

multiple: usize

InvalidGeneric

Fields

msg: &'static str

InvalidParameterEmptyArray

Fields

param_name: &'static str

InvalidParameterGreater

Fields

a_param_name: &'static str

b_param_name: &'static str

InvalidParameterValueEqual

Fields

param_name: &'static str

value: usize

InvalidParameterValueGreater

Fields

param_name: &'static str

value: usize

InvalidParameterValueLess

Fields

param_name: &'static str

value: usize

InvalidParameterValueOutsideRange

Fields

param_name: &'static str

value: f64

min: f64

max: f64

InvalidPositiveRange

Fields

start: usize

end: usize

InvalidSum

Fields

expected: f64

got: f64

MismatchedArrayLengths

Fields

a_arr_name: &'static str

a_arr_len: usize

b_arr_name: &'static str

b_arr_len: usize

MismatchedArrayShapes

Fields

a_arr_name: &'static str

a_shape: Vec<usize>

b_arr_name: &'static str

b_shape: Vec<usize>

MismatchedDimensionLengths

Fields

a_name: &'static str

a_dim_len: usize

b_name: &'static str

b_dim_len: usize

Trait Implementations

impl Clone for ImgalError

fn clone(&self) -> ImgalError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImgalError

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

Formats the value using the given formatter.

impl Display for ImgalError

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

Formats the value using the given formatter.

impl Error for ImgalError

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 ImgalError

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImgalError