ecore 0.10.0

no_std bit-level integer types, bitfield structs/enums, ranged integers, and enum maps
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

use super::*;

impl<T: PrimaryInt, const BITS: u32> BitInt<T, BITS> {
    /// Extracts `BITS` bits from a `u8` starting at `start_bit`.
    pub const fn extract_u8(value: u8, start_bit: usize) -> Self {
        Self::cast_new(CInt::cast_as(value >> start_bit))
    }

    /// Extracts `BITS` bits from a `u16` starting at `start_bit`.
    pub const fn extract_u16(value: u16, start_bit: usize) -> Self {
        Self::cast_new(CInt::cast_as(value >> start_bit))
    }

    /// Extracts `BITS` bits from a `u32` starting at `start_bit`.
    pub const fn extract_u32(value: u32, start_bit: usize) -> Self {
        Self::cast_new(CInt::cast_as(value >> start_bit))
    }

    /// Extracts `BITS` bits from a `u64` starting at `start_bit`.
    pub const fn extract_u64(value: u64, start_bit: usize) -> Self {
        Self::cast_new(CInt::cast_as(value >> start_bit))
    }

    /// Extracts `BITS` bits from a `u128` starting at `start_bit`.
    pub const fn extract_u128(value: u128, start_bit: usize) -> Self {
        Self::cast_new(CInt::cast_as(value >> start_bit))
    }

    /// Returns the bit-reversed value, where the LSB becomes the MSB within `BITS`.
    pub const fn reverse_bits(self) -> Self {
        Self(if BITS == 0 { T::ZERO } else { CInt::shr(CInt::reverse_bits(self.0), Self::UNUSED_BITS) })
    }
}