Struct nonminmax::NonMinIsize

#[repr(transparent)]
pub struct NonMinIsize { /* fields omitted */ }

An integer of type isize which is known to not equal isize::MIN.

This type allows for niche filling optimization (similar to the existing std::num::NonZero* types) meaning items such as Option<NonMinIsize> and Result<NonMinIsize, ()> take up the same amount of space as isize.

// Create using `new`, extract value using `get`
let x = NonMinIsize::new(123).unwrap();
assert_eq!(x.get(), 123);

// The value cannot be `isize::MIN`
let y = NonMinIsize::new(isize::MIN);
assert_eq!(y, None);

// Niche filling optimization works!
use std::mem::size_of;
assert_eq!(size_of::<isize>(), size_of::<NonMinIsize>());
assert_eq!(size_of::<isize>(), size_of::<Option<NonMinIsize>>());

Methods

impl NonMinIsize

pub fn new(value: isize) -> Option<Self>

Creates an instance of NonMinIsize by checking if the value is not isize::MIN.

pub unsafe fn new_unchecked(value: isize) -> Self

Creates an instance of NonMinIsize without checking if the value is not isize::MIN.

Safety

The value cannot be equal to isize::MIN.

pub fn get(self) -> isize

Returns the integer value.

Trait Implementations

impl Clone for NonMinIsize

fn clone(&self) -> NonMinIsize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for NonMinIsize

impl Debug for NonMinIsize

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

Formats the value using the given formatter.

impl Display for NonMinIsize

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

Formats the value using the given formatter.

impl Eq for NonMinIsize

impl From<NonMinIsize> for isize

fn from(nontype: NonMinIsize) -> Self

Performs the conversion.

impl Hash for NonMinIsize

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, 

Feeds a slice of this type into the given [Hasher].

impl Ord for NonMinIsize

fn cmp(&self, other: &NonMinIsize) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<NonMinIsize> for NonMinIsize

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<NonMinIsize> for NonMinIsize

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralEq for NonMinIsize

impl StructuralPartialEq for NonMinIsize