grixy 0.2.0

2-dimensional grids
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

use core::{
    fmt::Debug,
    mem,
    ops::{BitAnd, BitAndAssign, BitOrAssign, Not},
};

use crate::internal::Sealed;

/// An unsigned integer type that can be used as a bit buffer.
pub trait BitOps:
    Sized
    + TryFrom<usize, Error: Debug>
    + Copy
    + Sealed
    + BitAnd<Output = Self>
    + BitAndAssign
    + BitOrAssign
    + Not<Output = Self>
{
    /// The maximum width that can be represented by this type.
    const MAX_WIDTH: usize = mem::size_of::<Self>() * 8;

    /// Converts a `usize` into this type.
    ///
    /// ## Panics
    ///
    /// Panics if the value is larger than `Self::MAX_WIDTH`.
    #[must_use]
    fn from_usize(value: usize) -> Self {
        value.try_into().expect("Value exceeds maximum width")
    }

    /// Converts this type into a `usize`.
    fn to_usize(self) -> usize;
}

impl Sealed for u8 {}
impl BitOps for u8 {
    fn to_usize(self) -> usize {
        self as usize
    }
}

impl Sealed for u16 {}
impl BitOps for u16 {
    fn to_usize(self) -> usize {
        self as usize
    }
}

impl Sealed for u32 {}
impl BitOps for u32 {
    fn to_usize(self) -> usize {
        self as usize
    }
}

impl Sealed for usize {}
impl BitOps for usize {
    fn to_usize(self) -> usize {
        self
    }
}

#[cfg(target_pointer_width = "64")]
impl Sealed for u64 {}

#[cfg(target_pointer_width = "64")]
impl BitOps for u64 {
    #[allow(clippy::cast_possible_truncation)]
    fn to_usize(self) -> usize {
        self as usize
    }
}

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

    #[test]
    fn u8_to_usize() {
        let value: u8 = 42;
        assert_eq!(value.to_usize(), 42);
    }

    #[test]
    fn u16_to_usize() {
        let value: u16 = 42;
        assert_eq!(value.to_usize(), 42);
    }

    #[test]
    fn u32_to_usize() {
        let value: u32 = 42;
        assert_eq!(value.to_usize(), 42);
    }

    #[test]
    #[cfg(target_pointer_width = "64")]
    fn u64_to_usize() {
        let value: u64 = 42;
        assert_eq!(value.to_usize(), 42);
    }

    #[test]
    fn usize_to_usize() {
        let value: usize = 42;
        assert_eq!(value.to_usize(), 42);
    }
}