Enum arr_rs::errors::ArrayError

pub enum ArrayError {
    BroadcastShapeMismatch,
    ConcatenateShapeMismatch,
    ShapeMustMatchValuesLength,
    ShapesMustMatch {
        shape_1: Vec<usize>,
        shape_2: Vec<usize>,
    },
    SqueezeShapeOfAxisMustBeOne,
    AxisOutOfBounds,
    OutOfBounds {
        value: &'static str,
    },
    ParameterError {
        param: &'static str,
        message: &'static str,
    },
    UnsupportedDimension {
        supported: Vec<usize>,
    },
    MustBeUnique {
        value: String,
    },
    MustBeEqual {
        value1: String,
        value2: String,
    },
    MustBeOneOf {
        value1: String,
        value2: String,
    },
    NotImplemented,
}

ArrayError definition - errors that can be returned by the library

Variants

BroadcastShapeMismatch

Shape of two arrays must match for broadcast operation

ConcatenateShapeMismatch

Shape of two arrays must match for concatenate operation

ShapeMustMatchValuesLength

Shape mismatching the length of values to build the array from

ShapesMustMatch

Fields

shape_1: Vec<usize>

first shape to match

shape_2: Vec<usize>

second shape to match

Shape of two arrays must match

SqueezeShapeOfAxisMustBeOne

Axis to perform squeeze on must have a size of one

AxisOutOfBounds

axis is out of array’s bounds

OutOfBounds

Fields

value: &'static str

out of bounds value

value is out of bounds

ParameterError

Fields

param: &'static str

mismatching parameter

message: &'static str

parameter error message

Input parameter doesn’t match the criteria

UnsupportedDimension

Fields

supported: Vec<usize>

supported dimensions

Not defined for given dimension of input array

MustBeUnique

Fields

value: String

value

Collection must contain unique elements

MustBeEqual

Fields

value1: String

value 1

value2: String

value 2

Values must be equal

MustBeOneOf

Fields

value1: String

value 1

value2: String

value 2

Values must be one of

NotImplemented

Function is not implemented

Trait Implementations

impl Clone for ArrayError

fn clone(&self) -> ArrayError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayError

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

Formats the value using the given formatter.

impl Display for ArrayError

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

Formats the value using the given formatter.

impl Error for ArrayError

fn source(&self) -> Option<&(dyn Error + 'static)>

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<ArrayError> for ArrayError

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<ArrayError> for ArrayError

fn partial_cmp(&self, other: &ArrayError) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ArrayError