Struct Bitwise

#[repr(transparent)]
pub struct Bitwise<T>(pub T);

Available on _bit·· only.

Provides constant bitwise operations on T.

It’s implemented for: i8, i16, i32, i64, i128, isize, u8, u16, u32, u64, u128 and usize.

See also BitOps for the corresponding trait.

Tuple Fields

0: T

Implementations

impl Bitwise<i8>

Implementation for i8.

pub const BITS: u32 = 8u32

Available on crate feature _bit_i8 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: i8, start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: i8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: i8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i8 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i8 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i8 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i8 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i8 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i8 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i8 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i8 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i8 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i8 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i8 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i8 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i8 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i8 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<i16>

Implementation for i16.

pub const BITS: u32 = 16u32

Available on crate feature _bit_i16 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: i16, start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: i16, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: i16, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i16 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i16 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i16 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i16 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i16 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i16 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i16 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i16 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i16 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i16 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i16 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i16 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i16 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i16 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<i32>

Implementation for i32.

pub const BITS: u32 = 32u32

Available on crate feature _bit_i32 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: i32, start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: i32, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: i32, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i32 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i32 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i32 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i32 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i32 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i32 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i32 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i32 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i32 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i32 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i32 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i32 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i32 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i32 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<i64>

Implementation for i64.

pub const BITS: u32 = 64u32

Available on crate feature _bit_i64 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: i64, start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: i64, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: i64, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i64 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i64 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i64 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i64 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i64 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i64 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i64 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i64 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i64 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i64 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i64 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i64 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i64 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i64 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<i128>

Implementation for i128.

pub const BITS: u32 = 128u32

Available on crate feature _bit_i128 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: i128, start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: i128, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: i128, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_i128 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_i128 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i128 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i128 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_i128 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_i128 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i128 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i128 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i128 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i128 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i128 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i128 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_i128 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_i128 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<isize>

Implementation for isize.

pub const BITS: u32 = 64u32

Available on crate feature _bit_isize only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: isize, start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: isize, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: isize, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_isize only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_isize only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_isize only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_isize only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_isize only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_isize only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_isize only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_isize only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_isize only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_isize only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_isize only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_isize only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_isize only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_isize only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<u8>

Implementation for u8.

pub const BITS: u32 = 8u32

Available on crate feature _bit_u8 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: u8, start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: u8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: u8, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u8 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u8 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u8 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u8 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u8 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u8 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u8 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u8 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u8 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u8 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u8 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u8 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u8 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u8 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<u16>

Implementation for u16.

pub const BITS: u32 = 16u32

Available on crate feature _bit_u16 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: u16, start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: u16, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: u16, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u16 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u16 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u16 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u16 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u16 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u16 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u16 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u16 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u16 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u16 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u16 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u16 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u16 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u16 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<u32>

Implementation for u32.

pub const BITS: u32 = 32u32

Available on crate feature _bit_u32 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: u32, start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: u32, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: u32, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u32 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u32 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u32 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u32 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u32 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u32 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u32 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u32 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u32 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u32 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u32 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u32 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u32 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u32 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<u64>

Implementation for u64.

pub const BITS: u32 = 64u32

Available on crate feature _bit_u64 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: u64, start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: u64, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: u64, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u64 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u64 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u64 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u64 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u64 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u64 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u64 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u64 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u64 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u64 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u64 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u64 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u64 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u64 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<u128>

Implementation for u128.

pub const BITS: u32 = 128u32

Available on crate feature _bit_u128 only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: u128, start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: u128, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: u128, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_u128 only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_u128 only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u128 only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u128 only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_u128 only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_u128 only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u128 only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u128 only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u128 only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u128 only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u128 only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u128 only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_u128 only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_u128 only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

impl Bitwise<usize>

Implementation for usize.

pub const BITS: u32 = 64u32

Available on crate feature _bit_usize only.

The size in bits.

pub const fn mask_range(start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Returns a new bitmask of 1s from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    2.8 ns   163.0 ns
  64    2.0 ns    21.6 ns
  32    2.4 ns    12.1 ns
  16    2.6 ns     7.6 ns
   8    2.9 ns     8.4 ns

pub const fn mask_checked_range( start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Returns a new bitmask of ones from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Benchmarks

The current algorithm used can be more than 1 order of magnitude more efficient than a naive loop that sets the individual bits, as well as much more consistant across the spectrum of bitsizes.

The following table shows the compared benchmark for start=0 and end=BITS-1 measured on an i5-8350U CPU @ 1.70 Ghz:

bits   current    naive
----   -------   --------
 128    3.7 ns   145.0 ns
  64    3.2 ns    38.2 ns
  32    3.2 ns     9.0 ns
  16    3.2 ns     7.0 ns
   8    3.1 ns     6.7 ns

pub const fn get_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Gets the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Gets the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn get_value_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Gets the value of the bits in self from the [start..=end] range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn get_value_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Gets the value of the bits in self from the [start..=end] checked range.

Sets the rest of the bits to 0.

The bits in the specified range are shifted rightwards so that the least significant bit (LSB) aligns with the units place, forming the integer value.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Sets the bits in self to 1, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Sets the bits in self to 1, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_value_range(self, value: usize, start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Sets the given value into the bits from the [start..=end] range.

Leaves the rest of the bits unchanged.

The value is first masked to fit the size of the range, and then it is inserted into the specified bit range of self, replacing the existing bits in that range. The rest of the bits in self remain unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn set_value_checked_range( self, value: usize, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Sets the given value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn set_checked_value_checked_range( self, value: usize, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Sets the given checked value into the bits from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS, MismatchedIndices if start > end, and DataOverflow if value does not fit within the specified bit range.

pub const fn unset_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Unsets the bits in self to 0, from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn unset_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Unsets the bits in self to 0, from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn flip_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Flips the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn flip_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Flips the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn reverse_range(self, start: u32, end: u32) -> Self

Available on crate feature _bit_usize only.

Reverses the order of the bits in self from the [start..=end] range.

Leaves the rest of the bits unchanged.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn reverse_checked_range( self, start: u32, end: u32, ) -> Result<Self, MismatchedBounds>

Available on crate feature _bit_usize only.

Reverses the order of the bits in self from the [start..=end] checked range.

Leaves the rest of the bits unchanged.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_ones_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_usize only.

Counts the number of 1s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_ones_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_usize only.

Counts the number of 1s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn count_zeros_range(self, start: u32, end: u32) -> u32

Available on crate feature _bit_usize only.

Counts the number of 0s in self from the [start..=end] range.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn count_zeros_checked_range( self, start: u32, end: u32, ) -> Result<u32, MismatchedBounds>

Available on crate feature _bit_usize only.

Counts the number of 0s in self from the [start..=end] checked range.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_usize only.

Finds the index of the first 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_usize only.

Finds the index of the first 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_first_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_usize only.

Finds the index of the first 0 in self from the [start..=end] range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_first_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_usize only.

Finds the index of the first 0 in self from the [start..=end] checked range.

Returns None if there are no bits unset.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_one_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_usize only.

Finds the index of the last 1 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_one_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_usize only.

Finds the index of the last 1 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

pub const fn find_last_zero_range(self, start: u32, end: u32) -> Option<u32>

Available on crate feature _bit_usize only.

Finds the index of the last 0 in self from the [start..=end] range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Panics

Panics if start >= BITS || end >= BITS || start > end.

pub const fn find_last_zero_checked_range( self, start: u32, end: u32, ) -> Result<Option<u32>, MismatchedBounds>

Available on crate feature _bit_usize only.

Finds the index of the last 0 in self from the [start..=end] checked range.

Returns None if there are no bits set.

The index is relative to the entire sequence of self, not to the given start.

Errors

Returns IndexOutOfBounds if start >= BITS || end >= BITS and MismatchedIndices if start > end.

Trait Implementations

impl<T: Binary> Binary for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Clone> Clone for Bitwise<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Display> Display for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Hash> Hash for Bitwise<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Hasher> Hasher for Bitwise<T>

fn finish(&self) -> u64

Returns the hash value for the values written so far.

fn write(&mut self, bytes: &[u8])

Writes some data into this Hasher.

fn write_u8(&mut self, i: u8)

Writes a single u8 into this hasher.

fn write_u16(&mut self, i: u16)

Writes a single u16 into this hasher.

fn write_u32(&mut self, i: u32)

Writes a single u32 into this hasher.

fn write_u64(&mut self, i: u64)

Writes a single u64 into this hasher.

fn write_u128(&mut self, i: u128)

Writes a single u128 into this hasher.

fn write_usize(&mut self, i: usize)

Writes a single usize into this hasher.

fn write_i8(&mut self, i: i8)

Writes a single i8 into this hasher.

fn write_i16(&mut self, i: i16)

Writes a single i16 into this hasher.

fn write_i32(&mut self, i: i32)

Writes a single i32 into this hasher.

fn write_i64(&mut self, i: i64)

Writes a single i64 into this hasher.

fn write_i128(&mut self, i: i128)

Writes a single i128 into this hasher.

fn write_isize(&mut self, i: isize)

Writes a single isize into this hasher.

fn write_length_prefix(&mut self, len: usize)

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

Writes a length prefix into this hasher, as part of being prefix-free.

fn write_str(&mut self, s: &str)

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

Writes a single str into this hasher.

impl<T: LowerExp> LowerExp for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: LowerHex> LowerHex for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Octal> Octal for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Ord> Ord for Bitwise<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Bitwise<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Bitwise<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: UpperExp> UpperExp for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: UpperHex> UpperHex for Bitwise<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Copy> Copy for Bitwise<T>

impl<T: Eq> Eq for Bitwise<T>