Enum ValidationError 

#[non_exhaustive]
pub enum ValidationError {
    ShapeMismatch(Box<ShapeMismatch>),
    ShapeDataLengthMismatch {
        expected: usize,
        actual: usize,
    },
    RankMismatch {
        expected: usize,
        actual: usize,
    },
    AxisOutOfBounds {
        axis: usize,
        rank: usize,
    },
    DuplicateAxis {
        axis: usize,
        role: &'static str,
    },
    AxisRoleConflict {
        axis: usize,
        first_role: &'static str,
        second_role: &'static str,
    },
    InvalidPermutationLength {
        expected: usize,
        actual: usize,
    },
    InvalidSliceStep {
        step: isize,
    },
    InvalidSliceBounds {
        start: isize,
        end: isize,
        axis_len: usize,
    },
    DTypeMismatch {
        expected: DType,
        actual: DType,
    },
    InvalidArgument {
        argument: &'static str,
        message: String,
    },
    NonContiguousViewAsSlice,
    ViewOutOfBounds,
    OverlappingMutableLayout,
    IntegerOverflow,
}

Structured validation failures owned by the tensor data model.

Examples

use tenferro_tensor_core::{ShapeMismatch, ShapeVec, ValidationError};

let error: ValidationError = ShapeMismatch::ExpectedActual {
    expected: ShapeVec::from_vec(vec![2, 3]),
    actual: ShapeVec::from_vec(vec![6]),
}
.into();
assert!(error.to_string().contains("shape mismatch"));

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.

ShapeMismatch(Box<ShapeMismatch>)

ShapeDataLengthMismatch

Fields

expected: usize

actual: usize

RankMismatch

Fields

expected: usize

actual: usize

AxisOutOfBounds

Fields

axis: usize

rank: usize

DuplicateAxis

Fields

axis: usize

role: &'static str

AxisRoleConflict

Fields

axis: usize

first_role: &'static str

second_role: &'static str

InvalidPermutationLength

Fields

expected: usize

actual: usize

InvalidSliceStep

Fields

step: isize

InvalidSliceBounds

Fields

start: isize

end: isize

axis_len: usize

DTypeMismatch

Fields

expected: DType

actual: DType

InvalidArgument

Fields

argument: &'static str

message: String

NonContiguousViewAsSlice

ViewOutOfBounds

OverlappingMutableLayout

IntegerOverflow

Implementations

impl ValidationError

pub fn kind(&self) -> ValidationKind

Return the stable coarse classification for this validation failure.

Examples

use tenferro_tensor_core::{ValidationError, ValidationKind};

let error = ValidationError::AxisOutOfBounds { axis: 3, rank: 2 };
assert_eq!(error.kind(), ValidationKind::AxisOutOfBounds);

Trait Implementations

impl Clone for ValidationError

fn clone(&self) -> ValidationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Display for ValidationError

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

Formats the value using the given formatter.

impl Error for ValidationError

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<ShapeMismatch> for ValidationError

fn from(error: ShapeMismatch) -> Self

Converts to this type from the input type.

impl PartialEq for ValidationError

fn eq(&self, other: &ValidationError) -> 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 Eq for ValidationError

impl StructuralPartialEq for ValidationError