binf 1.1.4

A crate that adds utilities for dealing with binary flags
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

/*!
# binf, Binary flags
This crate aims to make working with binary/bit flags easier. It also provides a macro to add similar functionality to zig's packed structs with boolean fields.
*/

use std::ops::{Deref, DerefMut};

pub use binf_macros::*;

/// A trait for types that can be used as bit flags.
pub trait BitFlag {
    type T;
    /// Sets the flag at the given position to the given value.
    /// I don't know what happens if the position is larger than the number of bits in the type.
    fn set_flag(&mut self, position: u8, value: bool);
    /// Returns the value of the flag at the given position.
    /// I don't know what happens if the position is larger than the number of bits in the type.
    fn get_flag(&self, position: u8) -> bool;
    /// Returns an array of bools representing the flags.
    /// The first element in the array is the flag at position 0.
    fn flags(&self) -> Self::T;
    /// Sets the flags to the given values.
    /// flags can be any size, but if it is larger than the number of bits in the type only the first bits will be used.
    /// So if this is u8 flags should be 8 or less any more are ignored.
    fn set_flags(&mut self, flags: &[bool]);
}

/// implementation for u8. u8 means it can store 8 flags 1 flag per bit.
impl BitFlag for u8 {
    type T = [bool; 8];
    fn set_flag(&mut self, position: u8, value: bool) {
        if value {
            *self |= 1 << position;
        } else {
            *self &= !(1 << position);
        }
    }

    fn get_flag(&self, position: u8) -> bool {
        (*self & (1 << position)) != 0
    }

    fn flags(&self) -> Self::T {
        let mut flags = [false; 8];
        for (i, flag) in flags.iter_mut().enumerate() {
            *flag = self.get_flag(i as u8);
        }
        flags
    }

    fn set_flags(&mut self, flags: &[bool]) {
        for (i, v) in flags.iter().enumerate() {
            if i >= 8 {
                break;
            }
            self.set_flag(i as u8, *v);
        }
    }
}

impl BitFlag for u16 {
    type T = [bool; 16];
    fn set_flag(&mut self, position: u8, value: bool) {
        if value {
            *self |= 1 << position;
        } else {
            *self &= !(1 << position);
        }
    }

    fn get_flag(&self, position: u8) -> bool {
        (*self & (1 << position)) != 0
    }

    fn flags(&self) -> Self::T {
        let mut flags = [false; 16];
        for (i, flag) in flags.iter_mut().enumerate() {
            *flag = self.get_flag(i as u8);
        }
        flags
    }

    fn set_flags(&mut self, flags: &[bool]) {
        for (i, v) in flags.iter().enumerate() {
            if i >= 16 {
                break;
            }
            self.set_flag(i as u8, *v);
        }
    }
}

impl BitFlag for u32 {
    type T = [bool; 32];
    fn set_flag(&mut self, position: u8, value: bool) {
        if value {
            *self |= 1 << position;
        } else {
            *self &= !(1 << position);
        }
    }

    fn get_flag(&self, position: u8) -> bool {
        (*self & (1 << position)) != 0
    }

    fn flags(&self) -> Self::T {
        let mut flags = [false; 32];
        for (i, flag) in flags.iter_mut().enumerate() {
            *flag = self.get_flag(i as u8);
        }
        flags
    }

    fn set_flags(&mut self, flags: &[bool]) {
        for (i, v) in flags.iter().enumerate() {
            if i >= 32 {
                break;
            }
            self.set_flag(i as u8, *v);
        }
    }
}

impl BitFlag for u64 {
    type T = [bool; 64];
    fn set_flag(&mut self, position: u8, value: bool) {
        if value {
            *self |= 1 << position;
        } else {
            *self &= !(1 << position);
        }
    }

    fn get_flag(&self, position: u8) -> bool {
        (*self & (1 << position)) != 0
    }

    fn flags(&self) -> Self::T {
        let mut flags = [false; 64];
        for (i, flag) in flags.iter_mut().enumerate() {
            *flag = self.get_flag(i as u8);
        }
        flags
    }

    fn set_flags(&mut self, flags: &[bool]) {
        for (i, v) in flags.iter().enumerate() {
            if i >= 64 {
                break;
            }
            self.set_flag(i as u8, *v);
        }
    }
}

impl BitFlag for u128 {
    type T = [bool; 128];
    fn set_flag(&mut self, position: u8, value: bool) {
        if value {
            *self |= 1 << position;
        } else {
            *self &= !(1 << position);
        }
    }

    fn get_flag(&self, position: u8) -> bool {
        (*self & (1 << position)) != 0
    }

    fn flags(&self) -> Self::T {
        let mut flags = [false; 128];
        for (i, flag) in flags.iter_mut().enumerate() {
            *flag = self.get_flag(i as u8);
        }
        flags
    }

    fn set_flags(&mut self, flags: &[bool]) {
        for (i, v) in flags.iter().enumerate() {
            if i >= 128 {
                break;
            }
            self.set_flag(i as u8, *v);
        }
    }
}

/// A wrapper around a type that implements BitFlag. In case you don't want to import the trait and
/// see the trait methods on each unsized integer.
pub struct BitFlags<T>(T);

impl<T: BitFlag> BitFlags<T> {
    pub fn new(value: T) -> Self {
        Self(value)
    }

    /// Sets the flag at the given position to the given value.
    /// I don't know what happens if the position is larger than the number of bits in the type.
    pub fn set_flag(&mut self, position: u8, value: bool) {
        self.0.set_flag(position, value);
    }

    /// Returns the value of the flag at the given position.
    /// I don't know what happens if the position is larger than the number of bits in the type.
    pub fn get_flag(&self, position: u8) -> bool {
        self.0.get_flag(position)
    }

    /// Returns an array of bools representing the flags.
    /// The first element in the array is the flag at position 0.
    pub fn flags(&self) -> T::T {
        self.0.flags()
    }

    /// Sets the flags to the given values.
    /// flags can be any size, but if it is larger than the number of bits in the type only the first bits will be used.
    /// So if this is u8 flags should be 8 or less any more are ignored.
    pub fn set_flags(&mut self, flags: &[bool]) {
        self.0.set_flags(flags);
    }
}

impl<T: BitFlag> Deref for BitFlags<T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T: BitFlag> DerefMut for BitFlags<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}