Struct sp_std::num::NonZeroU1281.28.0[−][src]

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

An integer that is known not to equal zero.

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

use std::mem::size_of;
assert_eq!(size_of::<Option<core::num::NonZeroU128>>(), size_of::<u128>());

Implementations

`impl NonZeroU128`[src]

`pub const unsafe fn new_unchecked(n: u128) -> NonZeroU128`1.28.0 (const: 1.34.0)[src]

Creates a non-zero without checking the value.

Safety

The value must not be zero.

`pub const fn new(n: u128) -> Option<NonZeroU128>`1.28.0 (const: 1.47.0)[src]

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

`pub const fn get(self) -> u128`1.28.0 (const: 1.34.0)[src]

Returns the value as a primitive type.

`impl NonZeroU128`[src]

`pub const fn leading_zeros(self) -> u32`[src]

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

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:

#![feature(nonzero_leading_trailing_zeros)]
let n = std::num::NonZeroU128::new(u128::MAX).unwrap();

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

`pub const fn trailing_zeros(self) -> u32`[src]

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

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:

#![feature(nonzero_leading_trailing_zeros)]
let n = std::num::NonZeroU128::new(0b0101000).unwrap();

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

`impl NonZeroU128`[src]

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

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

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::NonZeroU128::new(8).unwrap();
assert!(eight.is_power_of_two());
let ten = std::num::NonZeroU128::new(10).unwrap();
assert!(!ten.is_power_of_two());

Trait Implementations

`impl Binary for NonZeroU128`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl BitOr<NonZeroU128> for NonZeroU128`1.45.0[src]

`type Output = NonZeroU128`

The resulting type after applying the | operator.

`pub fn bitor( self, rhs: NonZeroU128 ) -> <NonZeroU128 as BitOr<NonZeroU128>>::Output`[src]

`impl BitOr<NonZeroU128> for u128`1.45.0[src]

`type Output = NonZeroU128`

The resulting type after applying the | operator.

`pub fn bitor(self, rhs: NonZeroU128) -> <u128 as BitOr<NonZeroU128>>::Output`[src]

`impl BitOr<u128> for NonZeroU128`1.45.0[src]

`type Output = NonZeroU128`

The resulting type after applying the | operator.

`pub fn bitor(self, rhs: u128) -> <NonZeroU128 as BitOr<u128>>::Output`[src]

`impl BitOrAssign<NonZeroU128> for NonZeroU128`1.45.0[src]

`pub fn bitor_assign(&mut self, rhs: NonZeroU128)`[src]

`impl BitOrAssign<u128> for NonZeroU128`1.45.0[src]

`pub fn bitor_assign(&mut self, rhs: u128)`[src]

`impl Clone for NonZeroU128`[src]

`pub fn clone(&self) -> NonZeroU128`[src]

`pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for NonZeroU128`[src]

`impl Debug for NonZeroU128`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl Display for NonZeroU128`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl Div<NonZeroU128> for u128`1.51.0[src]

`type Output = u128`

The resulting type after applying the / operator.

`pub fn div(self, other: NonZeroU128) -> u128`[src]

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

`impl Eq for NonZeroU128`[src]

`impl From<NonZeroU128> for u128`1.31.0[src]

`pub fn from(nonzero: NonZeroU128) -> u128`[src]

Converts a NonZeroU128 into an u128

`impl From<NonZeroU16> for NonZeroU128`1.41.0[src]

Converts NonZeroU16 to NonZeroU128 losslessly.

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

`impl From<NonZeroU32> for NonZeroU128`1.41.0[src]

Converts NonZeroU32 to NonZeroU128 losslessly.

`pub fn from(small: NonZeroU32) -> NonZeroU128`[src]

`impl From<NonZeroU64> for NonZeroU128`1.41.0[src]

Converts NonZeroU64 to NonZeroU128 losslessly.

`pub fn from(small: NonZeroU64) -> NonZeroU128`[src]

`impl From<NonZeroU8> for NonZeroU128`1.41.0[src]

Converts NonZeroU8 to NonZeroU128 losslessly.

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

`impl FromStr for NonZeroU128`1.35.0[src]

`type Err = ParseIntError`

The associated error which can be returned from parsing.

`pub fn from_str(src: &str) -> Result<NonZeroU128, <NonZeroU128 as FromStr>::Err>`[src]

`impl Hash for NonZeroU128`[src]

`pub fn hash<H>(&self, state: &mut H) where __H: Hasher,` [src]

`pub fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,` 1.3.0[src]

`impl LowerHex for NonZeroU128`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl Octal for NonZeroU128`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

`impl Ord for NonZeroU128`[src]

`pub fn cmp(&self, other: &NonZeroU128) -> Ordering`[src]

`#[must_use]pub fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]pub fn min(self, other: Self) -> Self`1.21.0[src]

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

`impl PartialEq<NonZeroU128> for NonZeroU128`[src]

`pub fn eq(&self, other: &NonZeroU128) -> bool`[src]

`pub fn ne(&self, other: &NonZeroU128) -> bool`[src]

`impl PartialOrd<NonZeroU128> for NonZeroU128`[src]

`pub fn partial_cmp(&self, other: &NonZeroU128) -> Option<Ordering>`[src]

`pub fn lt(&self, other: &NonZeroU128) -> bool`[src]

`pub fn le(&self, other: &NonZeroU128) -> bool`[src]

`pub fn gt(&self, other: &NonZeroU128) -> bool`[src]

`pub fn ge(&self, other: &NonZeroU128) -> bool`[src]

`impl Rem<NonZeroU128> for u128`1.51.0[src]

`type Output = u128`

The resulting type after applying the % operator.

`pub fn rem(self, other: NonZeroU128) -> u128`[src]

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

`impl StructuralEq for NonZeroU128`[src]

`impl StructuralPartialEq for NonZeroU128`[src]

`impl TryFrom<NonZeroI128> for NonZeroU128`1.49.0[src]

Attempts to convert NonZeroI128 to NonZeroU128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroI16> for NonZeroU128`1.49.0[src]

Attempts to convert NonZeroI16 to NonZeroU128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroI32> for NonZeroU128`1.49.0[src]

Attempts to convert NonZeroI32 to NonZeroU128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroI64> for NonZeroU128`1.49.0[src]

Attempts to convert NonZeroI64 to NonZeroU128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroI8> for NonZeroU128`1.49.0[src]

Attempts to convert NonZeroI8 to NonZeroU128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroIsize> for NonZeroU128`1.49.0[src]

Attempts to convert NonZeroIsize to NonZeroU128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroI8`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI8.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroU8`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU8.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroI32`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI32.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroI64`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI64.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroI128`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroIsize`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroIsize.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroI16`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroI16.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroU16`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU16.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroU64`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU64.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroU128> for NonZeroUsize`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroUsize.

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

`impl TryFrom<NonZeroU128> for NonZeroU32`1.49.0[src]

Attempts to convert NonZeroU128 to NonZeroU32.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl TryFrom<NonZeroUsize> for NonZeroU128`1.49.0[src]

Attempts to convert NonZeroUsize to NonZeroU128.

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

`impl TryFrom<u128> for NonZeroU128`1.46.0[src]

Attempts to convert u128 to NonZeroU128.

`type Error = TryFromIntError`

The type returned in the event of a conversion error.

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

`impl UpperHex for NonZeroU128`[src]

`pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Auto Trait Implementations

`impl RefUnwindSafe for NonZeroU128`[src]

`impl Send for NonZeroU128`[src]

`impl Sync for NonZeroU128`[src]

`impl Unpin for NonZeroU128`[src]

`impl UnwindSafe for NonZeroU128`[src]

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &TⓘNotable traits for &'_ mut I impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

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

`pub fn borrow_mut(&mut self) -> &mut TⓘNotable traits for &'_ mut I impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;`[src]

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

`pub fn from(t: T) -> T`[src]

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

`pub fn into(self) -> U`[src]

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

`type Owned = T`

The resulting type after obtaining ownership.

`pub fn to_owned(&self) -> T`[src]

`pub fn clone_into(&self, target: &mut T)`[src]

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

`pub default fn to_string(&self) -> String`[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.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

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

`pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]