Trait NonZeroPrimitiveInteger

Source

pub trait NonZeroPrimitiveInteger:
    'static
    + NonZeroSealed
    + Eq
    + Ord
    + Into<Self::Integer>
    + TryFrom<Self::Integer, Error = TryFromIntError>
    + TryFrom<NonZero<i8>, Error: PrimitiveError>
    + TryFrom<NonZero<i16>, Error: PrimitiveError>
    + TryFrom<NonZero<i32>, Error: PrimitiveError>
    + TryFrom<NonZero<i64>, Error: PrimitiveError>
    + TryFrom<NonZero<i128>, Error: PrimitiveError>
    + TryFrom<NonZero<isize>, Error: PrimitiveError>
    + TryFrom<NonZero<u8>, Error: PrimitiveError>
    + TryFrom<NonZero<u16>, Error: PrimitiveError>
    + TryFrom<NonZero<u32>, Error: PrimitiveError>
    + TryFrom<NonZero<u64>, Error: PrimitiveError>
    + TryFrom<NonZero<u128>, Error: PrimitiveError>
    + TryFrom<NonZero<usize>, Error: PrimitiveError>
    + TryInto<NonZero<i8>, Error: PrimitiveError>
    + TryInto<NonZero<i16>, Error: PrimitiveError>
    + TryInto<NonZero<i32>, Error: PrimitiveError>
    + TryInto<NonZero<i64>, Error: PrimitiveError>
    + TryInto<NonZero<i128>, Error: PrimitiveError>
    + TryInto<NonZero<isize>, Error: PrimitiveError>
    + TryInto<NonZero<u8>, Error: PrimitiveError>
    + TryInto<NonZero<u16>, Error: PrimitiveError>
    + TryInto<NonZero<u32>, Error: PrimitiveError>
    + TryInto<NonZero<u64>, Error: PrimitiveError>
    + TryInto<NonZero<u128>, Error: PrimitiveError>
    + TryInto<NonZero<usize>, Error: PrimitiveError>
    + Binary
    + Debug
    + Display
    + LowerExp
    + LowerHex
    + Octal
    + UpperExp
    + UpperHex
    + Hash
    + Copy
    + Send
    + Sync
    + Unpin
    + BitOr<Self, Output = Self>
    + BitOr<Self::Integer, Output = Self>
    + BitOrAssign<Self>
    + BitOrAssign<Self::Integer>
    + RefUnwindSafe
    + UnwindSafe
    + FromStr<Err = ParseIntError> {
    type Integer: PrimitiveInteger<NonZero = Self>;

    const BITS: u32;
    const MAX: Self;
    const MIN: Self;

    // Required methods
    fn checked_mul(self, other: Self) -> Option<Self>;
    fn checked_pow(self, other: u32) -> Option<Self>;
    fn count_ones(self) -> NonZero<u32>;
    fn get(self) -> Self::Integer;
    fn leading_zeros(self) -> u32;
    fn new(n: Self::Integer) -> Option<Self>;
    fn saturating_mul(self, other: Self) -> Self;
    fn saturating_pow(self, other: u32) -> Self;
    fn trailing_zeros(self) -> u32;
    unsafe fn new_unchecked(n: Self::Integer) -> Self;
}

Expand description

Trait for NonZero primitive integers.

This encapsulates trait implementations, constants, and inherent methods that are common among all of the implementations of NonZero<T>, where T is a PrimitiveInteger.

See the corresponding items on the individual types for more documentation and examples.

This trait is sealed with a private trait to prevent downstream implementations, so we may continue to expand along with the standard library without worrying about breaking changes for implementors.

§Examples

use num_primitive::NonZeroPrimitiveInteger;
use core::num::NonZero;

fn bits_and_zeros<T: NonZeroPrimitiveInteger>(n: T) -> (u32, u32, u32) {
    (T::BITS, n.leading_zeros(), n.trailing_zeros())
}

assert_eq!(bits_and_zeros(NonZero::new(0b0010_1000u8).unwrap()), (8, 2, 3));
assert_eq!(bits_and_zeros(NonZero::new(1i64).unwrap()), (64, 63, 0));

Required Associated Constants§

Source

const BITS: u32

The size of this non-zero integer type in bits.

Source

const MAX: Self

The largest value that can be represented by this non-zero integer type.

Source

const MIN: Self

The smallest value that can be represented by this non-zero integer type.

Required Associated Types§

Source

type Integer: PrimitiveInteger<NonZero = Self>

The primitive integer type that this non-zero type wraps.

For core::num::NonZero<T>, this is T.

Required Methods§

Source

fn checked_mul(self, other: Self) -> Option<Self>

Multiplies two non-zero integers together. Returns None on overflow.

Source

fn checked_pow(self, other: u32) -> Option<Self>

Raises non-zero value to an integer power. Returns None on overflow.

Source

fn count_ones(self) -> NonZero<u32>

Returns the number of ones in the binary representation of self.

Source

fn get(self) -> Self::Integer

Returns the contained value as a primitive type.

Source

fn leading_zeros(self) -> u32

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

Source

fn new(n: Self::Integer) -> Option<Self>

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

Source

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

Multiplies two non-zero integers together, saturating at the numeric bounds instead of overflowing.

Source

fn saturating_pow(self, other: u32) -> Self

Raise non-zero value to an integer power, saturating at the numeric bounds instead of overflowing.

Source

fn trailing_zeros(self) -> u32

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

Source

unsafe fn new_unchecked(n: Self::Integer) -> Self

Creates a non-zero without checking whether the value is non-zero. This results in undefined behavior if the value is zero.

§Safety

The value must not be zero.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Trait NonZeroPrimitiveInteger Copy item path

§Examples

Required Associated Constants§

const BITS: u32

const MAX: Self

const MIN: Self

Required Associated Types§

type Integer: PrimitiveInteger<NonZero = Self>

Required Methods§

fn checked_mul(self, other: Self) -> Option<Self>

fn checked_pow(self, other: u32) -> Option<Self>

fn count_ones(self) -> NonZero<u32>

fn get(self) -> Self::Integer

fn leading_zeros(self) -> u32

fn new(n: Self::Integer) -> Option<Self>

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

fn saturating_pow(self, other: u32) -> Self

fn trailing_zeros(self) -> u32

unsafe fn new_unchecked(n: Self::Integer) -> Self

§Safety

Dyn Compatibility§

Implementations on Foreign Types§

impl NonZeroPrimitiveInteger for NonZero<i8>

const BITS: u32 = Self::BITS

const MAX: Self = Self::MAX

const MIN: Self = Self::MIN

fn new(n: Self::Integer) -> Option<Self>

fn checked_mul(self, other: Self) -> Option<Self>

fn checked_pow(self, other: u32) -> Option<Self>

fn count_ones(self) -> NonZero<u32>

fn get(self) -> Self::Integer

fn leading_zeros(self) -> u32

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

fn saturating_pow(self, other: u32) -> Self

fn trailing_zeros(self) -> u32

unsafe fn new_unchecked(n: Self::Integer) -> Self

type Integer = i8

impl NonZeroPrimitiveInteger for NonZero<i16>

const BITS: u32 = Self::BITS

const MAX: Self = Self::MAX

const MIN: Self = Self::MIN

fn new(n: Self::Integer) -> Option<Self>

fn checked_mul(self, other: Self) -> Option<Self>

fn checked_pow(self, other: u32) -> Option<Self>

fn count_ones(self) -> NonZero<u32>

fn get(self) -> Self::Integer

fn leading_zeros(self) -> u32

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

fn saturating_pow(self, other: u32) -> Self

fn trailing_zeros(self) -> u32

unsafe fn new_unchecked(n: Self::Integer) -> Self

type Integer = i16

impl NonZeroPrimitiveInteger for NonZero<i32>

const BITS: u32 = Self::BITS

const MAX: Self = Self::MAX

const MIN: Self = Self::MIN

fn new(n: Self::Integer) -> Option<Self>

fn checked_mul(self, other: Self) -> Option<Self>

fn checked_pow(self, other: u32) -> Option<Self>

fn count_ones(self) -> NonZero<u32>

fn get(self) -> Self::Integer

fn leading_zeros(self) -> u32

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

fn saturating_pow(self, other: u32) -> Self

fn trailing_zeros(self) -> u32

unsafe fn new_unchecked(n: Self::Integer) -> Self

type Integer = i32

impl NonZeroPrimitiveInteger for NonZero<i64>

const BITS: u32 = Self::BITS

const MAX: Self = Self::MAX

const MIN: Self = Self::MIN

fn new(n: Self::Integer) -> Option<Self>

fn checked_mul(self, other: Self) -> Option<Self>

fn checked_pow(self, other: u32) -> Option<Self>

fn count_ones(self) -> NonZero<u32>

fn get(self) -> Self::Integer

fn leading_zeros(self) -> u32

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

fn saturating_pow(self, other: u32) -> Self

fn trailing_zeros(self) -> u32

Trait NonZeroPrimitiveInteger