memacc 0.1.11

Memory access functions.
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

pub trait ReadFromAddress {
    type Type;
    fn read_from_address(self) -> Self::Type;
}

/// Implement [`ReadFromAddress`] for given type.
macro_rules! ImplementReadFromAddress {
    ($type:ty) => {
        impl ReadFromAddress for *mut $type {
            type Type = $type;
            #[allow(clippy::not_unsafe_ptr_arg_deref)]
            fn read_from_address(self) -> Self::Type {
                // SAFETY:
                // Programmer is responsible for reading from valid address.
                unsafe { self.read_volatile() }
            }
        }
    };
}

ImplementReadFromAddress!(u8);
ImplementReadFromAddress!(u16);
ImplementReadFromAddress!(u32);
ImplementReadFromAddress!(u64);

#[cfg(test)]
mod tests {
    use super::ReadFromAddress;

    #[test]
    fn test_read_from_address_u8() {
        let mut value = 0b1010_0110u8;
        let reference = &mut value;
        let address = reference as *mut u8;
        assert_eq!(address.read_from_address(), value);
    }

    #[test]
    fn test_read_from_address_u16() {
        let mut value = 0b1010_0110_1010_0110u16;
        let reference = &mut value;
        let address = reference as *mut u16;
        assert_eq!(address.read_from_address(), value);
    }

    #[test]
    fn test_read_from_address_u32() {
        let mut value = 0b1010_0110_1010_0110_1010_0110_1010_0110u32;
        let reference = &mut value;
        let address = reference as *mut u32;
        assert_eq!(address.read_from_address(), value);
    }

    #[test]
    fn test_read_from_address_u64() {
        let mut value =
            0b1010_0110_1010_0110_1010_0110_1010_0110_1010_0110_1010_0110_1010_0110_1010_0110u64;
        let reference = &mut value;
        let address = reference as *mut u64;
        assert_eq!(address.read_from_address(), value);
    }
}