bitfrob 1.3.0

A sibling crate for `bytemuck`, this is where forbid(unsafe_code) utilities live.
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
34
35
36

use crate::*;

/// Two `u8` values packed as a `u16`.
///
/// Compared to using `[u8; 2]`, this forces the data to have an alignment of 2,
/// and also keeps volatile reads and writes as a single access (when possible).
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[allow(non_camel_case_types)]
#[repr(transparent)]
pub struct u8x2(u16);
impl u8x2 {
  /// The lower byte
  #[inline]
  #[must_use]
  pub const fn low(self) -> u8 {
    u16_get_value(0, 7, self.0) as u8
  }
  /// Updates the lower byte value, returning the new `u8x2`
  #[inline]
  #[must_use]
  pub const fn with_low(self, low: u8) -> Self {
    Self(u16_with_value(0, 7, self.0, low as u16))
  }
  /// The upper byte
  #[inline]
  #[must_use]
  pub const fn high(self) -> u8 {
    u16_get_value(8, 15, self.0) as u8
  }
  /// Updates the upper byte value, returning the new `u8x2`
  #[inline]
  #[must_use]
  pub const fn with_high(self, high: u8) -> Self {
    Self(u16_with_value(8, 15, self.0, high as u16))
  }
}