phantom-fields 0.1.2

proc-macro for sub-fields inside of an integer value.
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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

use phantom_fields::phantom_fields;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u32)]
pub enum DisplayMode {
  Good = 0,
  Bad = 1,
  Ugly = 2,
}

pub const CONST_TEST_VALUE: u32 = 1 << 13;

#[derive(Debug, Default, Clone, Copy)]
#[repr(transparent)]
pub struct PhantomFieldsDemo(u32);

impl PhantomFieldsDemo {
  phantom_fields! {
    self.0: u32,
    /// enum_example docs
    enum_example: 0-2=DisplayMode<Good, Bad, Ugly>,
    bool_example: 3,
    int_example: 6-7,
    enum_example2: 10-12=DisplayMode<Good, Bad, Ugly>,
    const_example: CONST_TEST_VALUE,
  }
}

#[test]
fn enum_example_test() {
  assert_eq!(PhantomFieldsDemo::ENUM_EXAMPLE_MASK, 0b111);
  for &dm in [DisplayMode::Good, DisplayMode::Bad, DisplayMode::Ugly].iter() {
    assert_eq!(PhantomFieldsDemo(dm as u32).enum_example(), dm);
    assert_eq!(PhantomFieldsDemo(0).with_enum_example(dm).enum_example(), dm);
  }
}

#[test]
fn bool_example_test() {
  assert_eq!(PhantomFieldsDemo::BOOL_EXAMPLE_BIT, 1 << 3);
  assert!(!PhantomFieldsDemo(0).bool_example());
  assert!(PhantomFieldsDemo(PhantomFieldsDemo::BOOL_EXAMPLE_BIT).bool_example());
  assert!(PhantomFieldsDemo(0).with_bool_example(true).bool_example());
}

#[test]
fn int_example_test() {
  assert_eq!(PhantomFieldsDemo::INT_EXAMPLE_MASK, 0b11 << 6);
  assert_eq!(PhantomFieldsDemo(0).int_example(), 0);
  assert_eq!(PhantomFieldsDemo(PhantomFieldsDemo::INT_EXAMPLE_MASK).int_example(), 0b11);
  for i in 0..=0b11 {
    assert_eq!(PhantomFieldsDemo(0).with_int_example(i).int_example(), i);
  }
}

#[test]
fn enum_example2_test() {
  assert_eq!(PhantomFieldsDemo::ENUM_EXAMPLE2_MASK, 0b111 << 10);
  for &dm in [DisplayMode::Good, DisplayMode::Bad, DisplayMode::Ugly].iter() {
    assert_eq!(PhantomFieldsDemo((dm as u32) << 10).enum_example2(), dm);
    assert_eq!(PhantomFieldsDemo(0).with_enum_example2(dm).enum_example2(), dm);
  }
}

#[test]
fn const_example_test() {
  assert!(!PhantomFieldsDemo(0).const_example());
  assert!(PhantomFieldsDemo(CONST_TEST_VALUE).const_example());
  assert!(PhantomFieldsDemo(0).with_const_example(true).const_example());
}