Trait nonzero_ext::NonZeroAble

pub trait NonZeroAble {
    type NonZero: NonZero;
    fn into_nonzero(self) -> Option<Self::NonZero>;
    unsafe fn into_nonzero_unchecked(self) -> Self::NonZero;

    fn as_nonzero(self) -> Option<Self::NonZero>
    where
        Self: Sized,
    { ... }
    unsafe fn as_nonzero_unchecked(self) -> Self::NonZero
    where
        Self: Sized,
    { ... }
}

A trait identifying integral types that have a non-zeroable equivalent.

Associated Types

type NonZero: NonZero

The concrete non-zero type represented by an implementation of this trait. For example, for u8's implementation, it is NonZeroU8.

Loading content...

Required methods

fn into_nonzero(self) -> Option<Self::NonZero>

Converts the integer to its non-zero equivalent.

Examples

Trying to convert zero

let n: u16 = 0;
assert_eq!(n.into_nonzero(), None);

Converting a non-zero value

let n: usize = 20;
let non0n: NonZeroUsize = n.into_nonzero().expect("should result in a converted value");
assert_eq!(non0n.get(), 20);

unsafe fn into_nonzero_unchecked(self) -> Self::NonZero

Converts the integer to its non-zero equivalent without checking for zeroness.

This corresponds to the new_unchecked function on the corresponding NonZero type.

Safety

The value must not be zero.

Loading content...

Provided methods

fn as_nonzero(self) -> Option<Self::NonZero> where
    Self: Sized, 

Deprecated since 0.2.0:

Renamed to into_nonzero

Converts the integer to its non-zero equivalent.

Examples

Trying to convert zero

let n: u16 = 0;
assert_eq!(n.as_nonzero(), None);

Converting a non-zero value

let n: usize = 20;
let non0n: NonZeroUsize = n.as_nonzero().expect("should result in a converted value");
assert_eq!(non0n.get(), 20);

unsafe fn as_nonzero_unchecked(self) -> Self::NonZero where
    Self: Sized, 

Deprecated since 0.2.0:

Renamed to into_nonzero_unchecked

Converts the integer to its non-zero equivalent without checking for zeroness.

This corresponds to the new_unchecked function on the corresponding NonZero type.

Safety

The value must not be zero.

Loading content...

Implementations on Foreign Types

impl NonZeroAble for u8

type NonZero = NonZeroU8

fn into_nonzero(self) -> Option<NonZeroU8>

unsafe fn into_nonzero_unchecked(self) -> NonZeroU8

impl NonZeroAble for u16

type NonZero = NonZeroU16

fn into_nonzero(self) -> Option<NonZeroU16>

unsafe fn into_nonzero_unchecked(self) -> NonZeroU16

impl NonZeroAble for u32

type NonZero = NonZeroU32

fn into_nonzero(self) -> Option<NonZeroU32>

unsafe fn into_nonzero_unchecked(self) -> NonZeroU32

impl NonZeroAble for u64

type NonZero = NonZeroU64

fn into_nonzero(self) -> Option<NonZeroU64>

unsafe fn into_nonzero_unchecked(self) -> NonZeroU64

impl NonZeroAble for u128

type NonZero = NonZeroU128

fn into_nonzero(self) -> Option<NonZeroU128>

unsafe fn into_nonzero_unchecked(self) -> NonZeroU128

impl NonZeroAble for usize

type NonZero = NonZeroUsize

fn into_nonzero(self) -> Option<NonZeroUsize>

unsafe fn into_nonzero_unchecked(self) -> NonZeroUsize

impl NonZeroAble for i8

type NonZero = NonZeroI8

fn into_nonzero(self) -> Option<NonZeroI8>

unsafe fn into_nonzero_unchecked(self) -> NonZeroI8

impl NonZeroAble for i16

type NonZero = NonZeroI16

fn into_nonzero(self) -> Option<NonZeroI16>

unsafe fn into_nonzero_unchecked(self) -> NonZeroI16

impl NonZeroAble for i32

type NonZero = NonZeroI32

fn into_nonzero(self) -> Option<NonZeroI32>

unsafe fn into_nonzero_unchecked(self) -> NonZeroI32

impl NonZeroAble for i64

type NonZero = NonZeroI64

fn into_nonzero(self) -> Option<NonZeroI64>

unsafe fn into_nonzero_unchecked(self) -> NonZeroI64

impl NonZeroAble for i128

type NonZero = NonZeroI128

fn into_nonzero(self) -> Option<NonZeroI128>

unsafe fn into_nonzero_unchecked(self) -> NonZeroI128

impl NonZeroAble for isize

type NonZero = NonZeroIsize

fn into_nonzero(self) -> Option<NonZeroIsize>

unsafe fn into_nonzero_unchecked(self) -> NonZeroIsize

Loading content...

Implementors

Loading content...