Enum BoundErrorKind

Source
pub enum BoundErrorKind {
    LessThanZero,
    GreaterThanOne,
    Neither,
}
Expand description

Describes how a value falls outside the closed unit interval [0, 1]

§Examples

use unit_interval::{UnitInterval, BoundErrorKind};

let result = UnitInterval::new_checked(-0.5);
assert_eq!(result.unwrap_err().kind(), BoundErrorKind::LessThanZero);

let result = UnitInterval::new_checked(1.5);
assert_eq!(result.unwrap_err().kind(), BoundErrorKind::GreaterThanOne);

let result = UnitInterval::new_checked(f32::NAN);
assert_eq!(result.unwrap_err().kind(), BoundErrorKind::Neither);

Variants§

§

LessThanZero

The value is less than both zero and one

When T::zero() <= val is false but val <= T::one() is true.

§

GreaterThanOne

The value is greater than both zero and one

When T::zero() <= val is true but val <= T::one() is false.

§

Neither

The value is neither greater than or equal to zero nor less than or equal to one

When both T::zero() <= val and val <= T::one() are false.

This can mean 2 things:

  1. The value is NaN-like
  2. The comparison operations (PartialOrd) or Zero or One are incorrectly implemented for the type of the value

Trait Implementations§

Source§

impl Clone for BoundErrorKind

Source§

fn clone(&self) -> BoundErrorKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BoundErrorKind

Source§

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

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

impl PartialEq for BoundErrorKind

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for BoundErrorKind

Source§

impl Eq for BoundErrorKind

Source§

impl StructuralPartialEq for BoundErrorKind

Auto Trait Implementations§

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.