Struct nonzero_signed::NonZeroIsize

#[repr(transparent)]
pub struct NonZeroIsize(_);

An integer that is known not to equal zero.

This enables some memory layout optimization. For example, Option<NonZeroI32> is the same size as i32:

use std::mem::size_of;
use nonzero_signed::NonZeroI32;
assert_eq!(size_of::<Option<NonZeroI32>>(), size_of::<i32>());

Methods

impl NonZeroIsize

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

Create a non-zero without checking the value.

Safety

The value must not be zero.

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

Create a non-zero if the given value is not zero.

pub fn get(self) -> isize

Returns the value as a primitive type.

Trait Implementations

impl Eq for NonZeroIsize

impl PartialOrd<NonZeroIsize> for NonZeroIsize

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Copy for NonZeroIsize

impl PartialEq<NonZeroIsize> for NonZeroIsize

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

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

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

This method tests for !=.

impl Clone for NonZeroIsize

fn clone(&self) -> NonZeroIsize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for NonZeroIsize

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Binary for NonZeroIsize

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

Formats the value using the given formatter.

impl Debug for NonZeroIsize

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

Formats the value using the given formatter.

impl Display for NonZeroIsize

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

Formats the value using the given formatter.

impl UpperHex for NonZeroIsize

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

Formats the value using the given formatter.

impl LowerHex for NonZeroIsize

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

Formats the value using the given formatter.

impl Octal for NonZeroIsize

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

Formats the value using the given formatter.

impl Hash for NonZeroIsize

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].