Struct mz_ore::num::NonNeg

#[repr(transparent)]
pub struct NonNeg<T>(T)
where
    T: Signed + Display;

A wrapper type which ensures a signed number is non-negative.

Tuple Fields

0: T

Implementations

impl<T> NonNeg<T>

where T: Signed + Display,

pub fn min() -> NonNeg<T>

Returns the minimum value of the type.

pub fn max() -> NonNeg<T>

where T: UpperBounded,

Returns the maximum value of the type.

pub fn try_from(n: T) -> Result<NonNeg<T>, NonNegError>

Attempts to construct a NonNeg from its underlying type.

Returns an error if n is negative.

Trait Implementations

impl<T> Arbitrary for NonNeg<T>

where T: Signed + UpperBounded + Display + Debug + Copy + 'static, Range<T>: Strategy<Value = T>,

type Strategy = BoxedStrategy<NonNeg<T>>

The type of Strategy used to generate values of type Self.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl CastFrom<NonNeg<i64>> for usize

fn cast_from(from: NonNeg<i64>) -> usize

Performs the cast.

impl<T> Clone for NonNeg<T>

where T: Signed + Display + Clone,

fn clone(&self) -> NonNeg<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for NonNeg<T>

where T: Signed + Display + Debug,

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

Formats the value using the given formatter.

impl<T> Deref for NonNeg<T>

where T: Signed + Display,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'de, T> Deserialize<'de> for NonNeg<T>

where T: Signed + Display + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for NonNeg<T>

where T: Signed + Display,

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

Formats the value using the given formatter.

impl From<NonNeg<i64>> for u64

fn from(n: NonNeg<i64>) -> u64

Converts to this type from the input type.

impl<T> Hash for NonNeg<T>

where T: Signed + Display + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for NonNeg<T>

where T: Signed + Display + Ord,

fn cmp(&self, other: &NonNeg<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for NonNeg<T>

where T: Signed + Display + PartialEq,

fn eq(&self, other: &NonNeg<T>) -> 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<T> PartialOrd for NonNeg<T>

where T: Signed + Display + PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Serialize for NonNeg<T>

where T: Signed + Display + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for NonNeg<T>

where T: Signed + Display + Copy,

impl<T> Eq for NonNeg<T>

where T: Signed + Display + Eq,

impl<T> StructuralPartialEq for NonNeg<T>

where T: Signed + Display,