Struct std::num::NonZeroUsize1.28.0[][src]

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

An integer that is known not to equal zero.

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

use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroUsize>>(), size_of::<usize>());
Run

Implementations

impl NonZeroUsize[src]

pub const unsafe fn new_unchecked(n: usize) -> NonZeroUsize1.28.0 (const: 1.28.0)[src]

Creates a non-zero without checking the value.

Safety

The value must not be zero.

pub const fn new(n: usize) -> Option<NonZeroUsize>1.28.0 (const: 1.47.0)[src]

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

pub const fn get(self) -> usize1.28.0 (const: 1.34.0)[src]

Returns the value as a primitive type.

impl NonZeroUsize[src]

pub const fn leading_zeros(self) -> u321.53.0 (const: 1.53.0)[src]

Returns the number of leading zeros in the binary representation of self.

On many architectures, this function can perform better than leading_zeros() on the underlying integer type, as special handling of zero can be avoided.

Examples

Basic usage:

let n = std::num::NonZeroUsize::new(usize::MAX).unwrap();

assert_eq!(n.leading_zeros(), 0);
Run

pub const fn trailing_zeros(self) -> u321.53.0 (const: 1.53.0)[src]

Returns the number of trailing zeros in the binary representation of self.

On many architectures, this function can perform better than trailing_zeros() on the underlying integer type, as special handling of zero can be avoided.

Examples

Basic usage:

let n = std::num::NonZeroUsize::new(0b0101000).unwrap();

assert_eq!(n.trailing_zeros(), 3);
Run

impl NonZeroUsize[src]

pub const fn is_power_of_two(self) -> bool[src]

🔬 This is a nightly-only experimental API. (nonzero_is_power_of_two #81106)

Returns true if and only if self == (1 << k) for some k.

On many architectures, this function can perform better than is_power_of_two() on the underlying integer type, as special handling of zero can be avoided.

Examples

Basic usage:

#![feature(nonzero_is_power_of_two)]

let eight = std::num::NonZeroUsize::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroUsize::new(10).unwrap();
assert!(!ten.is_power_of_two());
Run

Trait Implementations

impl Binary for NonZeroUsize[src]

impl BitOr<NonZeroUsize> for usize1.45.0[src]

type Output = NonZeroUsize

The resulting type after applying the | operator.

impl BitOr<NonZeroUsize> for NonZeroUsize1.45.0[src]

type Output = NonZeroUsize

The resulting type after applying the | operator.

impl BitOr<usize> for NonZeroUsize1.45.0[src]

type Output = NonZeroUsize

The resulting type after applying the | operator.

impl BitOrAssign<NonZeroUsize> for NonZeroUsize1.45.0[src]

impl BitOrAssign<usize> for NonZeroUsize1.45.0[src]

impl Clone for NonZeroUsize[src]

impl Debug for NonZeroUsize[src]

impl Display for NonZeroUsize[src]

impl Div<NonZeroUsize> for usize1.51.0[src]

type Output = usize

The resulting type after applying the / operator.

pub fn div(self, other: NonZeroUsize) -> usize[src]

This operation rounds towards zero, truncating any fractional part of the exact result, and cannot panic.

impl From<NonZeroU16> for NonZeroUsize1.41.0[src]

pub fn from(small: NonZeroU16) -> NonZeroUsize[src]

Converts NonZeroU16 to NonZeroUsize losslessly.

impl From<NonZeroU8> for NonZeroUsize1.41.0[src]

pub fn from(small: NonZeroU8) -> NonZeroUsize[src]

Converts NonZeroU8 to NonZeroUsize losslessly.

impl From<NonZeroUsize> for usize1.31.0[src]

pub fn from(nonzero: NonZeroUsize) -> usize[src]

Converts a NonZeroUsize into an usize

impl FromStr for NonZeroUsize1.35.0[src]

type Err = ParseIntError

The associated error which can be returned from parsing.

impl Hash for NonZeroUsize[src]

impl LowerHex for NonZeroUsize[src]

impl Octal for NonZeroUsize[src]

impl Ord for NonZeroUsize[src]

impl PartialEq<NonZeroUsize> for NonZeroUsize[src]

impl PartialOrd<NonZeroUsize> for NonZeroUsize[src]

impl Rem<NonZeroUsize> for usize1.51.0[src]

type Output = usize

The resulting type after applying the % operator.

pub fn rem(self, other: NonZeroUsize) -> usize[src]

This operation satisfies n % d == n - (n / d) * d, and cannot panic.

impl TryFrom<NonZeroI128> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroI128
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI128>>::Error>
[src]

Attempts to convert NonZeroI128 to NonZeroUsize.

impl TryFrom<NonZeroI16> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroI16
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI16>>::Error>
[src]

Attempts to convert NonZeroI16 to NonZeroUsize.

impl TryFrom<NonZeroI32> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroI32
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI32>>::Error>
[src]

Attempts to convert NonZeroI32 to NonZeroUsize.

impl TryFrom<NonZeroI64> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroI64
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI64>>::Error>
[src]

Attempts to convert NonZeroI64 to NonZeroUsize.

impl TryFrom<NonZeroI8> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroI8
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroI8>>::Error>
[src]

Attempts to convert NonZeroI8 to NonZeroUsize.

impl TryFrom<NonZeroIsize> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroIsize
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroIsize>>::Error>
[src]

Attempts to convert NonZeroIsize to NonZeroUsize.

impl TryFrom<NonZeroU128> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroU128
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroU128>>::Error>
[src]

Attempts to convert NonZeroU128 to NonZeroUsize.

impl TryFrom<NonZeroU32> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroU32
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroU32>>::Error>
[src]

Attempts to convert NonZeroU32 to NonZeroUsize.

impl TryFrom<NonZeroU64> for NonZeroUsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroU64
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<NonZeroU64>>::Error>
[src]

Attempts to convert NonZeroU64 to NonZeroUsize.

impl TryFrom<NonZeroUsize> for NonZeroI321.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroI32, <NonZeroI32 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroI32.

impl TryFrom<NonZeroUsize> for NonZeroU641.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroU64, <NonZeroU64 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroU64.

impl TryFrom<NonZeroUsize> for NonZeroI1281.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroI128, <NonZeroI128 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroI128.

impl TryFrom<NonZeroUsize> for NonZeroU81.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroU8, <NonZeroU8 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroU8.

impl TryFrom<NonZeroUsize> for NonZeroI641.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroI64, <NonZeroI64 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroI64.

impl TryFrom<NonZeroUsize> for NonZeroU1281.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroU128, <NonZeroU128 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroU128.

impl TryFrom<NonZeroUsize> for NonZeroIsize1.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroIsize, <NonZeroIsize as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroIsize.

impl TryFrom<NonZeroUsize> for NonZeroU321.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroU32, <NonZeroU32 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroU32.

impl TryFrom<NonZeroUsize> for NonZeroU161.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroU16, <NonZeroU16 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroU16.

impl TryFrom<NonZeroUsize> for NonZeroI161.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroI16, <NonZeroI16 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroI16.

impl TryFrom<NonZeroUsize> for NonZeroI81.49.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: NonZeroUsize
) -> Result<NonZeroI8, <NonZeroI8 as TryFrom<NonZeroUsize>>::Error>
[src]

Attempts to convert NonZeroUsize to NonZeroI8.

impl TryFrom<usize> for NonZeroUsize1.46.0[src]

type Error = TryFromIntError

The type returned in the event of a conversion error.

pub fn try_from(
    value: usize
) -> Result<NonZeroUsize, <NonZeroUsize as TryFrom<usize>>::Error>
[src]

Attempts to convert usize to NonZeroUsize.

impl UpperHex for NonZeroUsize[src]

impl Copy for NonZeroUsize[src]

impl Eq for NonZeroUsize[src]

impl StructuralEq for NonZeroUsize[src]

impl StructuralPartialEq for NonZeroUsize[src]

Auto Trait Implementations

impl RefUnwindSafe for NonZeroUsize

impl Send for NonZeroUsize

impl Sync for NonZeroUsize

impl Unpin for NonZeroUsize

impl UnwindSafe for NonZeroUsize

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.