Skip to main content

Integer

lexical_util::num

Trait Integer

pub trait Integer:
    Number
    + Eq
    + Ord
    + BitAnd<Output = Self>
    + BitAndAssign
    + BitOr<Output = Self>
    + BitOrAssign
    + BitXor<Output = Self>
    + BitXorAssign
    + Not<Output = Self>
    + Shl<Self, Output = Self>
    + Shl<i32, Output = Self>
    + ShlAssign<i32>
    + Shr<i32, Output = Self>
    + ShrAssign<i32> {
    const ZERO: Self;
    const ONE: Self;
    const TWO: Self;
    const MAX: Self;
    const MIN: Self;
    const BITS: usize;
Show 25 methods
    // Required methods
    fn leading_zeros(self) -> u32;
    fn trailing_zeros(self) -> u32;
    fn pow(self, exp: u32) -> Self;
    fn checked_pow(self, exp: u32) -> Option<Self>;
    fn overflowing_pow(self, exp: u32) -> (Self, bool);
    fn checked_add(self, i: Self) -> Option<Self>;
    fn checked_sub(self, i: Self) -> Option<Self>;
    fn checked_mul(self, i: Self) -> Option<Self>;
    fn overflowing_add(self, i: Self) -> (Self, bool);
    fn overflowing_sub(self, i: Self) -> (Self, bool);
    fn overflowing_mul(self, i: Self) -> (Self, bool);
    fn wrapping_add(self, i: Self) -> Self;
    fn wrapping_sub(self, i: Self) -> Self;
    fn wrapping_mul(self, i: Self) -> Self;
    fn wrapping_neg(self) -> Self;
    fn saturating_add(self, i: Self) -> Self;
    fn saturating_sub(self, i: Self) -> Self;
    fn saturating_mul(self, i: Self) -> Self;

    // Provided methods
    fn ceil_divmod(self, y: Self) -> (Self, i32) { ... }
    fn ceil_div(self, y: Self) -> Self { ... }
    fn ceil_mod(self, y: Self) -> i32 { ... }
    fn bit_length(self) -> u32 { ... }
    fn is_odd(self) -> bool { ... }
    fn is_even(self) -> bool { ... }
    fn overflow_digits(radix: u32) -> usize { ... }
}

Expand description

Defines a trait that supports integral operations.

Required Associated Constants§

const ZERO: Self

const ONE: Self

const TWO: Self

const MAX: Self

const MIN: Self

const BITS: usize

Required Methods§

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

Provided Methods§

fn ceil_divmod(self, y: Self) -> (Self, i32)

Get the fast ceiling of the quotient from integer division. Not safe, since the remainder can easily overflow.

fn ceil_div(self, y: Self) -> Self

Get the fast ceiling of the quotient from integer division. Not safe, since the remainder can easily overflow.

fn ceil_mod(self, y: Self) -> i32

Get the fast ceiling modulus from integer division. Not safe, since the remainder can easily overflow.

fn bit_length(self) -> u32

Get the number of bits in a value.

fn is_odd(self) -> bool

Returns true if the least-significant bit is odd.

fn is_even(self) -> bool

Returns true if the least-significant bit is even.

fn overflow_digits(radix: u32) -> usize

Get the maximum number of digits before the slice will overflow.

This is effectively the floor(log(2**BITS-1, radix)), but we can try to go a bit lower without worrying too much.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types§

impl Integer for i8

const ZERO: i8 = 0

const ONE: i8 = 1

const TWO: i8 = 2

const MAX: i8 = i8::MAX

const MIN: i8 = i8::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for i16

const ZERO: i16 = 0

const ONE: i16 = 1

const TWO: i16 = 2

const MAX: i16 = i16::MAX

const MIN: i16 = i16::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for i32

const ZERO: i32 = 0

const ONE: i32 = 1

const TWO: i32 = 2

const MAX: i32 = i32::MAX

const MIN: i32 = i32::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for i64

const ZERO: i64 = 0

const ONE: i64 = 1

const TWO: i64 = 2

const MAX: i64 = i64::MAX

const MIN: i64 = i64::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for i128

const ZERO: i128 = 0

const ONE: i128 = 1

const TWO: i128 = 2

const MAX: i128 = i128::MAX

const MIN: i128 = i128::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for isize

const ZERO: isize = 0

const ONE: isize = 1

const TWO: isize = 2

const MAX: isize = isize::MAX

const MIN: isize = isize::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for u8

const ZERO: u8 = 0

const ONE: u8 = 1

const TWO: u8 = 2

const MAX: u8 = u8::MAX

const MIN: u8 = u8::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for u16

const ZERO: u16 = 0

const ONE: u16 = 1

const TWO: u16 = 2

const MAX: u16 = u16::MAX

const MIN: u16 = u16::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for u32

const ZERO: u32 = 0

const ONE: u32 = 1

const TWO: u32 = 2

const MAX: u32 = u32::MAX

const MIN: u32 = u32::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for u64

const ZERO: u64 = 0

const ONE: u64 = 1

const TWO: u64 = 2

const MAX: u64 = u64::MAX

const MIN: u64 = u64::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for u128

const ZERO: u128 = 0

const ONE: u128 = 1

const TWO: u128 = 2

const MAX: u128 = u128::MAX

const MIN: u128 = u128::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

impl Integer for usize

const ZERO: usize = 0

const ONE: usize = 1

const TWO: usize = 2

const MAX: usize = usize::MAX

const MIN: usize = usize::MIN

const BITS: usize

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn checked_add(self, i: Self) -> Option<Self>

fn checked_sub(self, i: Self) -> Option<Self>

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

fn overflowing_add(self, i: Self) -> (Self, bool)

fn overflowing_sub(self, i: Self) -> (Self, bool)

fn overflowing_mul(self, i: Self) -> (Self, bool)

fn wrapping_add(self, i: Self) -> Self

fn wrapping_sub(self, i: Self) -> Self

fn wrapping_mul(self, i: Self) -> Self

fn wrapping_neg(self) -> Self

fn pow(self, exp: u32) -> Self

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

fn overflowing_pow(self, exp: u32) -> (Self, bool)

fn saturating_add(self, i: Self) -> Self

fn saturating_sub(self, i: Self) -> Self

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

Implementors§