Struct scale_info::prelude::num::Wrapping
1.0.0 · source · pub struct Wrapping<T>(pub T);
Expand description
Provides intentionally-wrapped arithmetic on T
.
Operations like +
on u32
values are intended to never overflow,
and in some debug configurations overflow is detected and results
in a panic. While most arithmetic falls into this category, some
code explicitly expects and relies upon modular arithmetic (e.g.,
hashing).
Wrapping arithmetic can be achieved either through methods like
wrapping_add
, or through the Wrapping<T>
type, which says that
all standard arithmetic operations on the underlying value are
intended to have wrapping semantics.
The underlying value can be retrieved through the .0
index of the
Wrapping
tuple.
Examples
use std::num::Wrapping;
let zero = Wrapping(0u32);
let one = Wrapping(1u32);
assert_eq!(u32::MAX, (zero - one).0);
Layout
Wrapping<T>
is guaranteed to have the same layout and ABI as T
.
Tuple Fields§
§0: T
Implementations§
source§impl Wrapping<usize>
impl Wrapping<usize>
sourcepub const MIN: Wrapping<usize> = Self(usize::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<usize> = Self(usize::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<usize>>::MIN, Wrapping(usize::MIN));
sourcepub const MAX: Wrapping<usize> = Self(usize::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<usize> = Self(usize::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<usize>>::MAX, Wrapping(usize::MAX));
sourcepub const BITS: u32 = 64u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 64u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<usize>>::BITS, usize::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100usize);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0usize).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000usize);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<usize>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<usize>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<usize>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<usize>
pub const fn reverse_bits(self) -> Wrapping<usize>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<usize>) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<usize>) -> Wrapping<usize>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ausize);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<usize>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<usize>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<usize>) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<usize>) -> Wrapping<usize>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ausize);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<usize>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<usize>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<usize>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ausize);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<usize>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ausize);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<usize>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3usize).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<u8>
impl Wrapping<u8>
sourcepub const MIN: Wrapping<u8> = Self(u8::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<u8> = Self(u8::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u8>>::MIN, Wrapping(u8::MIN));
sourcepub const MAX: Wrapping<u8> = Self(u8::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<u8> = Self(u8::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u8>>::MAX, Wrapping(u8::MAX));
sourcepub const BITS: u32 = 8u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 8u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u8>>::BITS, u8::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100u8);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0u8).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000u8);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<u8>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<u8>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<u8>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<u8>
pub const fn reverse_bits(self) -> Wrapping<u8>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<u8>) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<u8>) -> Wrapping<u8>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au8);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<u8>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<u8>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<u8>) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<u8>) -> Wrapping<u8>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au8);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<u8>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<u8>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<u8>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au8);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<u8>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au8);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<u8>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3u8).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<u16>
impl Wrapping<u16>
sourcepub const MIN: Wrapping<u16> = Self(u16::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<u16> = Self(u16::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u16>>::MIN, Wrapping(u16::MIN));
sourcepub const MAX: Wrapping<u16> = Self(u16::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<u16> = Self(u16::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u16>>::MAX, Wrapping(u16::MAX));
sourcepub const BITS: u32 = 16u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 16u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u16>>::BITS, u16::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100u16);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0u16).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000u16);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<u16>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<u16>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<u16>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<u16>
pub const fn reverse_bits(self) -> Wrapping<u16>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<u16>) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<u16>) -> Wrapping<u16>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au16);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<u16>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<u16>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<u16>) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<u16>) -> Wrapping<u16>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au16);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<u16>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<u16>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<u16>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au16);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<u16>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au16);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<u16>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3u16).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<u32>
impl Wrapping<u32>
sourcepub const MIN: Wrapping<u32> = Self(u32::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<u32> = Self(u32::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u32>>::MIN, Wrapping(u32::MIN));
sourcepub const MAX: Wrapping<u32> = Self(u32::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<u32> = Self(u32::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u32>>::MAX, Wrapping(u32::MAX));
sourcepub const BITS: u32 = 32u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 32u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u32>>::BITS, u32::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100u32);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0u32).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000u32);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<u32>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<u32>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<u32>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<u32>
pub const fn reverse_bits(self) -> Wrapping<u32>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<u32>) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<u32>) -> Wrapping<u32>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au32);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<u32>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<u32>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<u32>) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<u32>) -> Wrapping<u32>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au32);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<u32>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<u32>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<u32>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au32);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<u32>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au32);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<u32>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3u32).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<u64>
impl Wrapping<u64>
sourcepub const MIN: Wrapping<u64> = Self(u64::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<u64> = Self(u64::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u64>>::MIN, Wrapping(u64::MIN));
sourcepub const MAX: Wrapping<u64> = Self(u64::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<u64> = Self(u64::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u64>>::MAX, Wrapping(u64::MAX));
sourcepub const BITS: u32 = 64u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 64u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u64>>::BITS, u64::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100u64);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0u64).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000u64);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<u64>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<u64>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<u64>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<u64>
pub const fn reverse_bits(self) -> Wrapping<u64>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<u64>) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<u64>) -> Wrapping<u64>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au64);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<u64>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<u64>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<u64>) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<u64>) -> Wrapping<u64>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au64);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<u64>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<u64>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<u64>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au64);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<u64>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au64);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<u64>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3u64).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<u128>
impl Wrapping<u128>
sourcepub const MIN: Wrapping<u128> = Self(u128::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<u128> = Self(u128::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u128>>::MIN, Wrapping(u128::MIN));
sourcepub const MAX: Wrapping<u128> = Self(u128::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<u128> = Self(u128::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u128>>::MAX, Wrapping(u128::MAX));
sourcepub const BITS: u32 = 128u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 128u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<u128>>::BITS, u128::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100u128);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0u128).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000u128);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<u128>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<u128>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<u128>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<u128>
pub const fn reverse_bits(self) -> Wrapping<u128>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<u128>) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<u128>) -> Wrapping<u128>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au128);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<u128>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<u128>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<u128>) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<u128>) -> Wrapping<u128>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au128);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<u128>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<u128>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<u128>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au128);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<u128>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Au128);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<u128>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3u128).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<isize>
impl Wrapping<isize>
sourcepub const MIN: Wrapping<isize> = Self(isize::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<isize> = Self(isize::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<isize>>::MIN, Wrapping(isize::MIN));
sourcepub const MAX: Wrapping<isize> = Self(isize::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<isize> = Self(isize::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<isize>>::MAX, Wrapping(isize::MAX));
sourcepub const BITS: u32 = 64u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 64u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<isize>>::BITS, isize::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100isize);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0isize).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000isize);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<isize>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<isize>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<isize>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<isize>
pub const fn reverse_bits(self) -> Wrapping<isize>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<isize>) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<isize>) -> Wrapping<isize>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Aisize);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<isize>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<isize>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<isize>) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<isize>) -> Wrapping<isize>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Aisize);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<isize>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<isize>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<isize>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Aisize);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<isize>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Aisize);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<isize>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3isize).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<i8>
impl Wrapping<i8>
sourcepub const MIN: Wrapping<i8> = Self(i8::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<i8> = Self(i8::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i8>>::MIN, Wrapping(i8::MIN));
sourcepub const MAX: Wrapping<i8> = Self(i8::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<i8> = Self(i8::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i8>>::MAX, Wrapping(i8::MAX));
sourcepub const BITS: u32 = 8u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 8u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i8>>::BITS, i8::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100i8);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0i8).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000i8);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<i8>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<i8>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<i8>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<i8>
pub const fn reverse_bits(self) -> Wrapping<i8>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<i8>) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<i8>) -> Wrapping<i8>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai8);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<i8>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<i8>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<i8>) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<i8>) -> Wrapping<i8>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai8);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<i8>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<i8>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<i8>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai8);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<i8>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai8);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<i8>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<i16>
impl Wrapping<i16>
sourcepub const MIN: Wrapping<i16> = Self(i16::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<i16> = Self(i16::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i16>>::MIN, Wrapping(i16::MIN));
sourcepub const MAX: Wrapping<i16> = Self(i16::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<i16> = Self(i16::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i16>>::MAX, Wrapping(i16::MAX));
sourcepub const BITS: u32 = 16u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 16u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i16>>::BITS, i16::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100i16);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0i16).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000i16);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<i16>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<i16>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<i16>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<i16>
pub const fn reverse_bits(self) -> Wrapping<i16>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<i16>) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<i16>) -> Wrapping<i16>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai16);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<i16>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<i16>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<i16>) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<i16>) -> Wrapping<i16>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai16);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<i16>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<i16>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<i16>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai16);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<i16>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai16);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<i16>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i16).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<i32>
impl Wrapping<i32>
sourcepub const MIN: Wrapping<i32> = Self(i32::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<i32> = Self(i32::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i32>>::MIN, Wrapping(i32::MIN));
sourcepub const MAX: Wrapping<i32> = Self(i32::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<i32> = Self(i32::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i32>>::MAX, Wrapping(i32::MAX));
sourcepub const BITS: u32 = 32u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 32u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i32>>::BITS, i32::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100i32);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0i32).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000i32);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<i32>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<i32>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<i32>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<i32>
pub const fn reverse_bits(self) -> Wrapping<i32>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<i32>) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<i32>) -> Wrapping<i32>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai32);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<i32>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<i32>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<i32>) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<i32>) -> Wrapping<i32>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai32);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<i32>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<i32>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<i32>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai32);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<i32>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai32);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<i32>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i32).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<i64>
impl Wrapping<i64>
sourcepub const MIN: Wrapping<i64> = Self(i64::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<i64> = Self(i64::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i64>>::MIN, Wrapping(i64::MIN));
sourcepub const MAX: Wrapping<i64> = Self(i64::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<i64> = Self(i64::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i64>>::MAX, Wrapping(i64::MAX));
sourcepub const BITS: u32 = 64u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 64u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i64>>::BITS, i64::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100i64);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0i64).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000i64);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<i64>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<i64>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<i64>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<i64>
pub const fn reverse_bits(self) -> Wrapping<i64>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<i64>) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<i64>) -> Wrapping<i64>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai64);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<i64>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<i64>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<i64>) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<i64>) -> Wrapping<i64>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai64);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<i64>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<i64>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<i64>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai64);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<i64>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai64);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<i64>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i64).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<i128>
impl Wrapping<i128>
sourcepub const MIN: Wrapping<i128> = Self(i128::MIN)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MIN: Wrapping<i128> = Self(i128::MIN)
wrapping_int_impl
)Returns the smallest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i128>>::MIN, Wrapping(i128::MIN));
sourcepub const MAX: Wrapping<i128> = Self(i128::MAX)
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const MAX: Wrapping<i128> = Self(i128::MAX)
wrapping_int_impl
)Returns the largest value that can be represented by this integer type.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i128>>::MAX, Wrapping(i128::MAX));
sourcepub const BITS: u32 = 128u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const BITS: u32 = 128u32
wrapping_int_impl
)Returns the size of this integer type in bits.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(<Wrapping<i128>>::BITS, i128::BITS);
sourcepub const fn count_ones(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_ones(self) -> u32
wrapping_int_impl
)Returns the number of ones in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b01001100i128);
assert_eq!(n.count_ones(), 3);
sourcepub const fn count_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn count_zeros(self) -> u32
wrapping_int_impl
)Returns the number of zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(!0i128).count_zeros(), 0);
sourcepub const fn trailing_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn trailing_zeros(self) -> u32
wrapping_int_impl
)Returns the number of trailing zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0b0101000i128);
assert_eq!(n.trailing_zeros(), 3);
sourcepub const fn rotate_left(self, n: u32) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_left(self, n: u32) -> Wrapping<i128>
wrapping_int_impl
)Shifts the bits to the left by a specified amount, n
,
wrapping the truncated bits to the end of the resulting
integer.
Please note this isn’t the same operation as the <<
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0x76543210FEDCBA99);
assert_eq!(n.rotate_left(32), m);
sourcepub const fn rotate_right(self, n: u32) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn rotate_right(self, n: u32) -> Wrapping<i128>
wrapping_int_impl
)Shifts the bits to the right by a specified amount, n
,
wrapping the truncated bits to the beginning of the resulting
integer.
Please note this isn’t the same operation as the >>
shifting
operator!
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i64> = Wrapping(0x0123456789ABCDEF);
let m: Wrapping<i64> = Wrapping(-0xFEDCBA987654322);
assert_eq!(n.rotate_right(4), m);
sourcepub const fn swap_bytes(self) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn swap_bytes(self) -> Wrapping<i128>
wrapping_int_impl
)Reverses the byte order of the integer.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n: Wrapping<i16> = Wrapping(0b0000000_01010101);
assert_eq!(n, Wrapping(85));
let m = n.swap_bytes();
assert_eq!(m, Wrapping(0b01010101_00000000));
assert_eq!(m, Wrapping(21760));
1.37.0 (const: 1.37.0) · sourcepub const fn reverse_bits(self) -> Wrapping<i128>
pub const fn reverse_bits(self) -> Wrapping<i128>
Reverses the bit pattern of the integer.
Examples
Please note that this example is shared between integer types.
Which explains why i16
is used here.
Basic usage:
use std::num::Wrapping;
let n = Wrapping(0b0000000_01010101i16);
assert_eq!(n, Wrapping(85));
let m = n.reverse_bits();
assert_eq!(m.0 as u16, 0b10101010_00000000);
assert_eq!(m, Wrapping(-22016));
sourcepub const fn from_be(x: Wrapping<i128>) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_be(x: Wrapping<i128>) -> Wrapping<i128>
wrapping_int_impl
)Converts an integer from big endian to the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai128);
if cfg!(target_endian = "big") {
assert_eq!(<Wrapping<i128>>::from_be(n), n)
} else {
assert_eq!(<Wrapping<i128>>::from_be(n), n.swap_bytes())
}
sourcepub const fn from_le(x: Wrapping<i128>) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn from_le(x: Wrapping<i128>) -> Wrapping<i128>
wrapping_int_impl
)Converts an integer from little endian to the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai128);
if cfg!(target_endian = "little") {
assert_eq!(<Wrapping<i128>>::from_le(n), n)
} else {
assert_eq!(<Wrapping<i128>>::from_le(n), n.swap_bytes())
}
sourcepub const fn to_be(self) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_be(self) -> Wrapping<i128>
wrapping_int_impl
)Converts self
to big endian from the target’s endianness.
On big endian this is a no-op. On little endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai128);
if cfg!(target_endian = "big") {
assert_eq!(n.to_be(), n)
} else {
assert_eq!(n.to_be(), n.swap_bytes())
}
sourcepub const fn to_le(self) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn to_le(self) -> Wrapping<i128>
wrapping_int_impl
)Converts self
to little endian from the target’s endianness.
On little endian this is a no-op. On big endian the bytes are swapped.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(0x1Ai128);
if cfg!(target_endian = "little") {
assert_eq!(n.to_le(), n)
} else {
assert_eq!(n.to_le(), n.swap_bytes())
}
sourcepub fn pow(self, exp: u32) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn pow(self, exp: u32) -> Wrapping<i128>
wrapping_int_impl
)Raises self to the power of exp
, using exponentiation by squaring.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i128).pow(4), Wrapping(81));
Results that are too large are wrapped:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(3i8).pow(5), Wrapping(-13));
assert_eq!(Wrapping(3i8).pow(6), Wrapping(-39));
source§impl Wrapping<isize>
impl Wrapping<isize>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(isize::MAX) >> 2;
assert_eq!(n.leading_zeros(), 3);
sourcepub fn abs(self) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn abs(self) -> Wrapping<isize>
wrapping_int_impl
)Computes the absolute value of self
, wrapping around at
the boundary of the type.
The only case where such wrapping can occur is when one takes the absolute value of the negative
minimal value for the type this is a positive value that is too large to represent in the type. In
such a case, this function returns MIN
itself.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(100isize).abs(), Wrapping(100));
assert_eq!(Wrapping(-100isize).abs(), Wrapping(100));
assert_eq!(Wrapping(isize::MIN).abs(), Wrapping(isize::MIN));
assert_eq!(Wrapping(-128i8).abs().0 as u8, 128u8);
sourcepub fn signum(self) -> Wrapping<isize>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn signum(self) -> Wrapping<isize>
wrapping_int_impl
)Returns a number representing sign of self
.
0
if the number is zero1
if the number is positive-1
if the number is negative
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(10isize).signum(), Wrapping(1));
assert_eq!(Wrapping(0isize).signum(), Wrapping(0));
assert_eq!(Wrapping(-10isize).signum(), Wrapping(-1));
sourcepub const fn is_positive(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_positive(self) -> bool
wrapping_int_impl
)Returns true
if self
is positive and false
if the number is zero or
negative.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(10isize).is_positive());
assert!(!Wrapping(-10isize).is_positive());
sourcepub const fn is_negative(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_negative(self) -> bool
wrapping_int_impl
)Returns true
if self
is negative and false
if the number is zero or
positive.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(-10isize).is_negative());
assert!(!Wrapping(10isize).is_negative());
source§impl Wrapping<i8>
impl Wrapping<i8>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(i8::MAX) >> 2;
assert_eq!(n.leading_zeros(), 3);
sourcepub fn abs(self) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn abs(self) -> Wrapping<i8>
wrapping_int_impl
)Computes the absolute value of self
, wrapping around at
the boundary of the type.
The only case where such wrapping can occur is when one takes the absolute value of the negative
minimal value for the type this is a positive value that is too large to represent in the type. In
such a case, this function returns MIN
itself.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(100i8).abs(), Wrapping(100));
assert_eq!(Wrapping(-100i8).abs(), Wrapping(100));
assert_eq!(Wrapping(i8::MIN).abs(), Wrapping(i8::MIN));
assert_eq!(Wrapping(-128i8).abs().0 as u8, 128u8);
sourcepub fn signum(self) -> Wrapping<i8>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn signum(self) -> Wrapping<i8>
wrapping_int_impl
)Returns a number representing sign of self
.
0
if the number is zero1
if the number is positive-1
if the number is negative
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(10i8).signum(), Wrapping(1));
assert_eq!(Wrapping(0i8).signum(), Wrapping(0));
assert_eq!(Wrapping(-10i8).signum(), Wrapping(-1));
sourcepub const fn is_positive(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_positive(self) -> bool
wrapping_int_impl
)Returns true
if self
is positive and false
if the number is zero or
negative.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(10i8).is_positive());
assert!(!Wrapping(-10i8).is_positive());
sourcepub const fn is_negative(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_negative(self) -> bool
wrapping_int_impl
)Returns true
if self
is negative and false
if the number is zero or
positive.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(-10i8).is_negative());
assert!(!Wrapping(10i8).is_negative());
source§impl Wrapping<i16>
impl Wrapping<i16>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(i16::MAX) >> 2;
assert_eq!(n.leading_zeros(), 3);
sourcepub fn abs(self) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn abs(self) -> Wrapping<i16>
wrapping_int_impl
)Computes the absolute value of self
, wrapping around at
the boundary of the type.
The only case where such wrapping can occur is when one takes the absolute value of the negative
minimal value for the type this is a positive value that is too large to represent in the type. In
such a case, this function returns MIN
itself.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(100i16).abs(), Wrapping(100));
assert_eq!(Wrapping(-100i16).abs(), Wrapping(100));
assert_eq!(Wrapping(i16::MIN).abs(), Wrapping(i16::MIN));
assert_eq!(Wrapping(-128i8).abs().0 as u8, 128u8);
sourcepub fn signum(self) -> Wrapping<i16>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn signum(self) -> Wrapping<i16>
wrapping_int_impl
)Returns a number representing sign of self
.
0
if the number is zero1
if the number is positive-1
if the number is negative
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(10i16).signum(), Wrapping(1));
assert_eq!(Wrapping(0i16).signum(), Wrapping(0));
assert_eq!(Wrapping(-10i16).signum(), Wrapping(-1));
sourcepub const fn is_positive(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_positive(self) -> bool
wrapping_int_impl
)Returns true
if self
is positive and false
if the number is zero or
negative.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(10i16).is_positive());
assert!(!Wrapping(-10i16).is_positive());
sourcepub const fn is_negative(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_negative(self) -> bool
wrapping_int_impl
)Returns true
if self
is negative and false
if the number is zero or
positive.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(-10i16).is_negative());
assert!(!Wrapping(10i16).is_negative());
source§impl Wrapping<i32>
impl Wrapping<i32>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(i32::MAX) >> 2;
assert_eq!(n.leading_zeros(), 3);
sourcepub fn abs(self) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn abs(self) -> Wrapping<i32>
wrapping_int_impl
)Computes the absolute value of self
, wrapping around at
the boundary of the type.
The only case where such wrapping can occur is when one takes the absolute value of the negative
minimal value for the type this is a positive value that is too large to represent in the type. In
such a case, this function returns MIN
itself.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(100i32).abs(), Wrapping(100));
assert_eq!(Wrapping(-100i32).abs(), Wrapping(100));
assert_eq!(Wrapping(i32::MIN).abs(), Wrapping(i32::MIN));
assert_eq!(Wrapping(-128i8).abs().0 as u8, 128u8);
sourcepub fn signum(self) -> Wrapping<i32>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn signum(self) -> Wrapping<i32>
wrapping_int_impl
)Returns a number representing sign of self
.
0
if the number is zero1
if the number is positive-1
if the number is negative
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(10i32).signum(), Wrapping(1));
assert_eq!(Wrapping(0i32).signum(), Wrapping(0));
assert_eq!(Wrapping(-10i32).signum(), Wrapping(-1));
sourcepub const fn is_positive(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_positive(self) -> bool
wrapping_int_impl
)Returns true
if self
is positive and false
if the number is zero or
negative.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(10i32).is_positive());
assert!(!Wrapping(-10i32).is_positive());
sourcepub const fn is_negative(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_negative(self) -> bool
wrapping_int_impl
)Returns true
if self
is negative and false
if the number is zero or
positive.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(-10i32).is_negative());
assert!(!Wrapping(10i32).is_negative());
source§impl Wrapping<i64>
impl Wrapping<i64>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(i64::MAX) >> 2;
assert_eq!(n.leading_zeros(), 3);
sourcepub fn abs(self) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn abs(self) -> Wrapping<i64>
wrapping_int_impl
)Computes the absolute value of self
, wrapping around at
the boundary of the type.
The only case where such wrapping can occur is when one takes the absolute value of the negative
minimal value for the type this is a positive value that is too large to represent in the type. In
such a case, this function returns MIN
itself.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(100i64).abs(), Wrapping(100));
assert_eq!(Wrapping(-100i64).abs(), Wrapping(100));
assert_eq!(Wrapping(i64::MIN).abs(), Wrapping(i64::MIN));
assert_eq!(Wrapping(-128i8).abs().0 as u8, 128u8);
sourcepub fn signum(self) -> Wrapping<i64>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn signum(self) -> Wrapping<i64>
wrapping_int_impl
)Returns a number representing sign of self
.
0
if the number is zero1
if the number is positive-1
if the number is negative
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(10i64).signum(), Wrapping(1));
assert_eq!(Wrapping(0i64).signum(), Wrapping(0));
assert_eq!(Wrapping(-10i64).signum(), Wrapping(-1));
sourcepub const fn is_positive(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_positive(self) -> bool
wrapping_int_impl
)Returns true
if self
is positive and false
if the number is zero or
negative.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(10i64).is_positive());
assert!(!Wrapping(-10i64).is_positive());
sourcepub const fn is_negative(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_negative(self) -> bool
wrapping_int_impl
)Returns true
if self
is negative and false
if the number is zero or
positive.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(-10i64).is_negative());
assert!(!Wrapping(10i64).is_negative());
source§impl Wrapping<i128>
impl Wrapping<i128>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(i128::MAX) >> 2;
assert_eq!(n.leading_zeros(), 3);
sourcepub fn abs(self) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn abs(self) -> Wrapping<i128>
wrapping_int_impl
)Computes the absolute value of self
, wrapping around at
the boundary of the type.
The only case where such wrapping can occur is when one takes the absolute value of the negative
minimal value for the type this is a positive value that is too large to represent in the type. In
such a case, this function returns MIN
itself.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(100i128).abs(), Wrapping(100));
assert_eq!(Wrapping(-100i128).abs(), Wrapping(100));
assert_eq!(Wrapping(i128::MIN).abs(), Wrapping(i128::MIN));
assert_eq!(Wrapping(-128i8).abs().0 as u8, 128u8);
sourcepub fn signum(self) -> Wrapping<i128>
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn signum(self) -> Wrapping<i128>
wrapping_int_impl
)Returns a number representing sign of self
.
0
if the number is zero1
if the number is positive-1
if the number is negative
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert_eq!(Wrapping(10i128).signum(), Wrapping(1));
assert_eq!(Wrapping(0i128).signum(), Wrapping(0));
assert_eq!(Wrapping(-10i128).signum(), Wrapping(-1));
sourcepub const fn is_positive(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_positive(self) -> bool
wrapping_int_impl
)Returns true
if self
is positive and false
if the number is zero or
negative.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(10i128).is_positive());
assert!(!Wrapping(-10i128).is_positive());
sourcepub const fn is_negative(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn is_negative(self) -> bool
wrapping_int_impl
)Returns true
if self
is negative and false
if the number is zero or
positive.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(-10i128).is_negative());
assert!(!Wrapping(10i128).is_negative());
source§impl Wrapping<usize>
impl Wrapping<usize>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(usize::MAX) >> 2;
assert_eq!(n.leading_zeros(), 2);
sourcepub fn is_power_of_two(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn is_power_of_two(self) -> bool
wrapping_int_impl
)Returns true
if and only if self == 2^k
for some k
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(16usize).is_power_of_two());
assert!(!Wrapping(10usize).is_power_of_two());
sourcepub fn next_power_of_two(self) -> Wrapping<usize>
🔬This is a nightly-only experimental API. (wrapping_next_power_of_two
)
pub fn next_power_of_two(self) -> Wrapping<usize>
wrapping_next_power_of_two
)Returns the smallest power of two greater than or equal to self
.
When return value overflows (i.e., self > (1 << (N-1))
for type
uN
), overflows to 2^N = 0
.
Examples
Basic usage:
#![feature(wrapping_next_power_of_two)]
use std::num::Wrapping;
assert_eq!(Wrapping(2usize).next_power_of_two(), Wrapping(2));
assert_eq!(Wrapping(3usize).next_power_of_two(), Wrapping(4));
assert_eq!(Wrapping(200_u8).next_power_of_two(), Wrapping(0));
source§impl Wrapping<u8>
impl Wrapping<u8>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(u8::MAX) >> 2;
assert_eq!(n.leading_zeros(), 2);
sourcepub fn is_power_of_two(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn is_power_of_two(self) -> bool
wrapping_int_impl
)Returns true
if and only if self == 2^k
for some k
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(16u8).is_power_of_two());
assert!(!Wrapping(10u8).is_power_of_two());
sourcepub fn next_power_of_two(self) -> Wrapping<u8>
🔬This is a nightly-only experimental API. (wrapping_next_power_of_two
)
pub fn next_power_of_two(self) -> Wrapping<u8>
wrapping_next_power_of_two
)Returns the smallest power of two greater than or equal to self
.
When return value overflows (i.e., self > (1 << (N-1))
for type
uN
), overflows to 2^N = 0
.
Examples
Basic usage:
#![feature(wrapping_next_power_of_two)]
use std::num::Wrapping;
assert_eq!(Wrapping(2u8).next_power_of_two(), Wrapping(2));
assert_eq!(Wrapping(3u8).next_power_of_two(), Wrapping(4));
assert_eq!(Wrapping(200_u8).next_power_of_two(), Wrapping(0));
source§impl Wrapping<u16>
impl Wrapping<u16>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(u16::MAX) >> 2;
assert_eq!(n.leading_zeros(), 2);
sourcepub fn is_power_of_two(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn is_power_of_two(self) -> bool
wrapping_int_impl
)Returns true
if and only if self == 2^k
for some k
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(16u16).is_power_of_two());
assert!(!Wrapping(10u16).is_power_of_two());
sourcepub fn next_power_of_two(self) -> Wrapping<u16>
🔬This is a nightly-only experimental API. (wrapping_next_power_of_two
)
pub fn next_power_of_two(self) -> Wrapping<u16>
wrapping_next_power_of_two
)Returns the smallest power of two greater than or equal to self
.
When return value overflows (i.e., self > (1 << (N-1))
for type
uN
), overflows to 2^N = 0
.
Examples
Basic usage:
#![feature(wrapping_next_power_of_two)]
use std::num::Wrapping;
assert_eq!(Wrapping(2u16).next_power_of_two(), Wrapping(2));
assert_eq!(Wrapping(3u16).next_power_of_two(), Wrapping(4));
assert_eq!(Wrapping(200_u8).next_power_of_two(), Wrapping(0));
source§impl Wrapping<u32>
impl Wrapping<u32>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(u32::MAX) >> 2;
assert_eq!(n.leading_zeros(), 2);
sourcepub fn is_power_of_two(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn is_power_of_two(self) -> bool
wrapping_int_impl
)Returns true
if and only if self == 2^k
for some k
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(16u32).is_power_of_two());
assert!(!Wrapping(10u32).is_power_of_two());
sourcepub fn next_power_of_two(self) -> Wrapping<u32>
🔬This is a nightly-only experimental API. (wrapping_next_power_of_two
)
pub fn next_power_of_two(self) -> Wrapping<u32>
wrapping_next_power_of_two
)Returns the smallest power of two greater than or equal to self
.
When return value overflows (i.e., self > (1 << (N-1))
for type
uN
), overflows to 2^N = 0
.
Examples
Basic usage:
#![feature(wrapping_next_power_of_two)]
use std::num::Wrapping;
assert_eq!(Wrapping(2u32).next_power_of_two(), Wrapping(2));
assert_eq!(Wrapping(3u32).next_power_of_two(), Wrapping(4));
assert_eq!(Wrapping(200_u8).next_power_of_two(), Wrapping(0));
source§impl Wrapping<u64>
impl Wrapping<u64>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(u64::MAX) >> 2;
assert_eq!(n.leading_zeros(), 2);
sourcepub fn is_power_of_two(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn is_power_of_two(self) -> bool
wrapping_int_impl
)Returns true
if and only if self == 2^k
for some k
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(16u64).is_power_of_two());
assert!(!Wrapping(10u64).is_power_of_two());
sourcepub fn next_power_of_two(self) -> Wrapping<u64>
🔬This is a nightly-only experimental API. (wrapping_next_power_of_two
)
pub fn next_power_of_two(self) -> Wrapping<u64>
wrapping_next_power_of_two
)Returns the smallest power of two greater than or equal to self
.
When return value overflows (i.e., self > (1 << (N-1))
for type
uN
), overflows to 2^N = 0
.
Examples
Basic usage:
#![feature(wrapping_next_power_of_two)]
use std::num::Wrapping;
assert_eq!(Wrapping(2u64).next_power_of_two(), Wrapping(2));
assert_eq!(Wrapping(3u64).next_power_of_two(), Wrapping(4));
assert_eq!(Wrapping(200_u8).next_power_of_two(), Wrapping(0));
source§impl Wrapping<u128>
impl Wrapping<u128>
sourcepub const fn leading_zeros(self) -> u32
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub const fn leading_zeros(self) -> u32
wrapping_int_impl
)Returns the number of leading zeros in the binary representation of self
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
let n = Wrapping(u128::MAX) >> 2;
assert_eq!(n.leading_zeros(), 2);
sourcepub fn is_power_of_two(self) -> bool
🔬This is a nightly-only experimental API. (wrapping_int_impl
)
pub fn is_power_of_two(self) -> bool
wrapping_int_impl
)Returns true
if and only if self == 2^k
for some k
.
Examples
Basic usage:
#![feature(wrapping_int_impl)]
use std::num::Wrapping;
assert!(Wrapping(16u128).is_power_of_two());
assert!(!Wrapping(10u128).is_power_of_two());
sourcepub fn next_power_of_two(self) -> Wrapping<u128>
🔬This is a nightly-only experimental API. (wrapping_next_power_of_two
)
pub fn next_power_of_two(self) -> Wrapping<u128>
wrapping_next_power_of_two
)Returns the smallest power of two greater than or equal to self
.
When return value overflows (i.e., self > (1 << (N-1))
for type
uN
), overflows to 2^N = 0
.
Examples
Basic usage:
#![feature(wrapping_next_power_of_two)]
use std::num::Wrapping;
assert_eq!(Wrapping(2u128).next_power_of_two(), Wrapping(2));
assert_eq!(Wrapping(3u128).next_power_of_two(), Wrapping(4));
assert_eq!(Wrapping(200_u8).next_power_of_two(), Wrapping(0));
Trait Implementations§
source§impl<'de, T> Deserialize<'de> for Wrapping<T>where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for Wrapping<T>where
T: Deserialize<'de>,
source§fn deserialize<D>(
deserializer: D
) -> Result<Wrapping<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
fn deserialize<D>(
deserializer: D
) -> Result<Wrapping<T>, <D as Deserializer<'de>>::Error>where
D: Deserializer<'de>,
source§impl<T> Ord for Wrapping<T>where
T: Ord,
impl<T> Ord for Wrapping<T>where
T: Ord,
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<T> PartialEq<Wrapping<T>> for Wrapping<T>where
T: PartialEq<T>,
impl<T> PartialEq<Wrapping<T>> for Wrapping<T>where
T: PartialEq<T>,
source§impl<T> PartialOrd<Wrapping<T>> for Wrapping<T>where
T: PartialOrd<T>,
impl<T> PartialOrd<Wrapping<T>> for Wrapping<T>where
T: PartialOrd<T>,
source§impl<T> Serialize for Wrapping<T>where
T: Serialize,
impl<T> Serialize for Wrapping<T>where
T: Serialize,
source§fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,
impl<T> Copy for Wrapping<T>where
T: Copy,
impl<T> Eq for Wrapping<T>where
T: Eq,
impl<T> StructuralEq for Wrapping<T>
impl<T> StructuralPartialEq for Wrapping<T>
Auto Trait Implementations§
impl<T> RefUnwindSafe for Wrapping<T>where
T: RefUnwindSafe,
impl<T> Send for Wrapping<T>where
T: Send,
impl<T> Sync for Wrapping<T>where
T: Sync,
impl<T> Unpin for Wrapping<T>where
T: Unpin,
impl<T> UnwindSafe for Wrapping<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> Rwhere
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> Rwhere
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> Rwhere
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> Rwhere
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,
source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Selfwhere
Self: Deref<Target = T>,
T: ?Sized,
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Selfwhere
Self: DerefMut<Target = T> + Deref,
T: ?Sized,
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds. Read moresource§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Selfwhere
Self: Borrow<B>,
B: ?Sized,
.tap_borrow()
only in debug builds, and is erased in release
builds. Read moresource§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Selfwhere
Self: BorrowMut<B>,
B: ?Sized,
.tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read moresource§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Selfwhere
Self: AsRef<R>,
R: ?Sized,
.tap_ref()
only in debug builds, and is erased in release
builds. Read moresource§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Selfwhere
Self: AsMut<R>,
R: ?Sized,
.tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more