Struct NonZero

pub struct NonZero;

Marker type enforcing that a value is non-zero (not equal to zero).

Use this type with Constrained<T, NonZero> to encode a non-zero constraint at the type level.

You can construct a value constrained to be non-zero using either the generic Constrained::new method or the convenient NonZero::new associated function.

Examples

use twine_core::constraint::{Constrained, NonZero};

// Generic constructor:
let x = Constrained::<_, NonZero>::new(1).unwrap();
assert_eq!(x.into_inner(), 1);

// Associated constructor:
let y = NonZero::new(-5.0).unwrap();
assert_eq!(y.into_inner(), -5.0);

// Error cases:
assert!(NonZero::new(0).is_err());
assert!(NonZero::new(0.0).is_err());
assert!(NonZero::new(f64::NAN).is_err());

Implementations

impl NonZero

pub fn new<T: PartialOrd + Zero>( value: T, ) -> Result<Constrained<T, NonZero>, ConstraintError>

Constructs a Constrained<T, NonZero> if the value is not zero.

Errors

Returns an error if the value is zero or not a number (NaN).

Trait Implementations

impl Clone for NonZero

fn clone(&self) -> NonZero

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: PartialOrd + Zero> Constraint<T> for NonZero

fn check(value: &T) -> Result<(), ConstraintError>

Checks that the given value satisfies this constraint.

impl Debug for NonZero

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

Formats the value using the given formatter.

impl PartialEq for NonZero

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

impl Eq for NonZero

impl StructuralPartialEq for NonZero