ErrorsNonNegativeRealScalar

Enum ErrorsNonNegativeRealScalar 

Source
pub enum ErrorsNonNegativeRealScalar<RealType: RealScalar> {
    NegativeValue {
        value: RealType,
        backtrace: Backtrace,
    },
}
Expand description

Error type for NonNegativeRealScalar<T> validation failures.

This enum provides error information when attempting to construct a NonNegativeRealScalar<T> with a negative value.

§Error Variants

Note that zero is valid for NonNegativeRealScalar, unlike PositiveRealScalar.

§Examples

use num_valid::scalars::{NonNegativeRealScalar, ErrorsNonNegativeRealScalar};
use try_create::TryNew;

// Zero is valid for NonNegativeRealScalar
let zero = NonNegativeRealScalar::try_new(0.0_f64);
assert!(zero.is_ok());

// Negative values are rejected
match NonNegativeRealScalar::try_new(-1.0_f64) {
    Err(ErrorsNonNegativeRealScalar::NegativeValue { value, .. }) => {
        assert_eq!(value, -1.0);
    }
    _ => unreachable!(),
}

Variants§

§

NegativeValue

The input value was negative (must be ≥ 0).

Fields

§value: RealType

The negative value that was rejected.

§backtrace: Backtrace

Stack trace for debugging.

Trait Implementations§

Source§

impl<RealType: Debug + RealScalar> Debug for ErrorsNonNegativeRealScalar<RealType>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<RealType> Display for ErrorsNonNegativeRealScalar<RealType>
where RealType: Display + RealScalar,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<RealType: RealScalar> Error for ErrorsNonNegativeRealScalar<RealType>
where Self: Debug + Display,

Source§

fn provide<'_request>(&'_request self, request: &mut Request<'_request>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

Auto Trait Implementations§

§

impl<RealType> !Freeze for ErrorsNonNegativeRealScalar<RealType>

§

impl<RealType> RefUnwindSafe for ErrorsNonNegativeRealScalar<RealType>
where <RealType as RealScalar>::RawReal: Sized, RealType: RefUnwindSafe,

§

impl<RealType> Send for ErrorsNonNegativeRealScalar<RealType>
where <RealType as RealScalar>::RawReal: Sized,

§

impl<RealType> Sync for ErrorsNonNegativeRealScalar<RealType>
where <RealType as RealScalar>::RawReal: Sized,

§

impl<RealType> Unpin for ErrorsNonNegativeRealScalar<RealType>
where <RealType as RealScalar>::RawReal: Sized, RealType: Unpin,

§

impl<RealType> UnwindSafe for ErrorsNonNegativeRealScalar<RealType>
where <RealType as RealScalar>::RawReal: Sized, RealType: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.