bitcraft 1.0.0

A zero-cost, hardware-aligned bitfield and enumeration generator.
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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

/// A declarative macro for generating atomic packed arrays backed by a single atomic integer.
///
/// Automatically selects the **smallest** atomic integer base (`AtomicU8`→`AtomicU128`)
/// for the given element width and count.
///
/// # Supported element types
/// - `bool` — single bit, returned as `bool`
/// - `u N` — unsigned N-bit integer
/// - `i N` — signed N-bit integer (sign-extended on `get`)
#[macro_export]
macro_rules! atomic_bitarray {
    // =========================================================================
    // bool (1 bit) → choose smallest AtomicUX that holds $count bits
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool,  1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  bool,1, 1,unsigned,bool_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool,  2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  bool,1, 2,unsigned,bool_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool,  4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  bool,1, 4,unsigned,bool_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool,  8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  bool,1, 8,unsigned,bool_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool, 16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, bool,1,16,unsigned,bool_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool, 32);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, bool,1,32,unsigned,bool_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool, 64);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, bool,1,64,unsigned,bool_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool,128);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,bool,1,128,unsigned,bool_type); };
    // fallback bool
    ($(#[$meta:meta])* $vis:vis struct $name:ident (bool, $count:literal);) => {
        const _: () = { assert!($count <= 128, "atomic_bitarray bool: count exceeds 128"); };
        $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,bool,1,$count,unsigned,bool_type);
    };

    // =========================================================================
    // Width 1 (individual bits as u/i)
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1,  1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,1, 1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1,  2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,1, 2,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1,  4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,1, 4,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1,  8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,1, 8,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1, 16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, u128,1,16,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1, 32);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, u128,1,32,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1, 64);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, u128,1,64,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 1,128);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,1,128,unsigned,int_type); };

    // =========================================================================
    // Width 2
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 2, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,2, 1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 2, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,2, 2,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 2, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,2, 4,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 2, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, u128,2, 8,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 2,16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, u128,2,16,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 2,32);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, u128,2,32,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 2,64);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,2,64,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 2, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  i128,2, 1,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 2, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  i128,2, 2,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 2, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  i128,2, 4,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 2, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, i128,2, 8,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 2,16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, i128,2,16,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 2,32);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, i128,2,32,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 2,64);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,2,64,signed,int_type); };

    // =========================================================================
    // Width 4 (nibbles)
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 4, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,4, 1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 4, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,4, 2,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 4, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, u128,4, 4,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 4, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, u128,4, 8,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 4,16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, u128,4,16,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 4,32);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,4,32,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 4, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  i128,4, 1,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 4, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  i128,4, 2,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 4, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, i128,4, 4,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 4, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, i128,4, 8,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 4,16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, i128,4,16,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 4,32);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,4,32,signed,int_type); };

    // =========================================================================
    // Width 8 (bytes)
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 8, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  u128,8, 1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 8, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, u128,8, 2,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 8, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, u128,8, 4,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 8, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, u128,8, 8,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 8,16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,8,16,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 8, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u8,  AtomicU8,  i128,8, 1,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 8, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, i128,8, 2,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 8, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, i128,8, 4,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 8, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, i128,8, 8,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 8,16);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,8,16,signed,int_type); };

    // =========================================================================
    // Width 16
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 16, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, u128,16, 1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 16, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, u128,16, 2,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 16, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, u128,16, 4,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 16, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,16, 8,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 16, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u16, AtomicU16, i128,16, 1,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 16, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, i128,16, 2,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 16, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, i128,16, 4,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 16, 8);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,16, 8,signed,int_type); };

    // =========================================================================
    // Width 32
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 32, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, u128,32,1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 32, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, u128,32,2,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 32, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,32,4,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 32, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u32, AtomicU32, i128,32,1,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 32, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, i128,32,2,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 32, 4);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,32,4,signed,int_type); };

    // =========================================================================
    // Width 64
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 64, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, u128,64,1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 64, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,64,2,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 64, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u64, AtomicU64, i128,64,1,signed,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 64, 2);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,64,2,signed,int_type); };

    // =========================================================================
    // Width 128
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u 128, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,128,1,unsigned,int_type); };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i 128, 1);) => { $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,128,1,signed,int_type); };

    // =========================================================================
    // General fallback
    // =========================================================================
    ($(#[$meta:meta])* $vis:vis struct $name:ident (u $width:literal, $count:literal);) => {
        const _: () = { assert!($width * $count <= 128, "atomic_bitarray: total bits exceed 128-bit limit"); };
        $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,u128,$width,$count,unsigned,int_type);
    };
    ($(#[$meta:meta])* $vis:vis struct $name:ident (i $width:literal, $count:literal);) => {
        const _: () = { assert!($width * $count <= 128, "atomic_bitarray: total bits exceed 128-bit limit"); };
        $crate::__atomic_bitarray_final!($(#[$meta])* $vis,$name,u128,AtomicU128,i128,$width,$count,signed,int_type);
    };
}

#[macro_export]
#[doc(hidden)]
macro_rules! __atomic_bitarray_final {
    ($(#[$meta:meta])* $vis:vis, $name:ident, $base_ty:ty, $atomic_ty:ident, $elem_ty:ty, $width:literal, $count:literal, $signed_tag:ident, $type_tag:ident) => {
        $(#[$meta])*
        #[repr(transparent)]
        $vis struct $name(pub $crate::reexport::portable_atomic::$atomic_ty);

        impl core::fmt::Debug for $name {
            fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
                let mut list = f.debug_list();
                for i in 0..$count {
                    list.entry(&self.get(i, $crate::Ordering::Relaxed));
                }
                list.finish()
            }
        }

        impl $name {
            pub const ELEMENT_WIDTH: usize = $width;
            pub const ELEMENT_COUNT: usize = $count;
            pub const TOTAL_BITS:    usize = $width * $count;
            pub const MASK: $base_ty = if $width >= <$base_ty as $crate::BitLength>::BITS {
                !0 as $base_ty
            } else {
                ((1 as $base_ty) << $width) - 1
            };

            #[inline(always)]
            pub const fn new(val: $base_ty) -> Self {
                Self($crate::reexport::portable_atomic::$atomic_ty::new(val))
            }

            #[inline(always)]
            pub fn load(&self, order: $crate::Ordering) -> $base_ty {
                self.0.load(order)
            }

            #[inline(always)]
            pub fn store(&self, val: $base_ty, order: $crate::Ordering) {
                self.0.store(val, order);
            }

            #[inline]
            pub fn get(&self, index: usize, order: $crate::Ordering) -> $elem_ty {
                debug_assert!(index < $count, "atomic_bitarray index out of bounds");
                let shift = index * $width;
                let raw   = (self.0.load(order) >> shift) & Self::MASK;
                $crate::__bitarray_cast_get!(raw, $elem_ty, $width, $signed_tag, $type_tag)
            }

            #[inline]
            pub fn set(&self, index: usize, value: $elem_ty, order: $crate::Ordering) {
                debug_assert!(index < $count, "atomic_bitarray index out of bounds");
                let shift      = index * $width;
                let val_masked = ($crate::__bitarray_cast_set!(value, $base_ty, $type_tag) & Self::MASK) << shift;
                let mask       = !(Self::MASK << shift);

                self.0.fetch_update(order, $crate::Ordering::Relaxed, |raw| {
                    Some((raw & mask) | val_masked)
                }).unwrap();
            }
        }

        $crate::__atomic_bitarray_snapshot!($vis, $name, $width, $count, $signed_tag, $type_tag);

        $crate::paste::paste! {
            impl $name {
                /// Returns a non-atomic snapshot of the current state.
                #[inline]
                pub fn get_snapshot(&self, order: $crate::Ordering) -> [<$name Value>] {
                    [<$name Value>]::new(self.0.load(order))
                }

                /// Completely overwrites the entire atomic state with the given snapshot.
                #[inline]
                pub fn set_snapshot(&self, val: [<$name Value>], order: $crate::Ordering) {
                    self.0.store(val.to_bits(), order);
                }

                /// Atomically updates the array using a CAS loop.
                #[inline]
                pub fn update<F>(&self, set_order: $crate::Ordering, fetch_order: $crate::Ordering, mut f: F) -> [<$name Value>]
                where
                    F: FnMut(&mut [<$name Value>])
                {
                    let raw_prev = self.0.fetch_update(set_order, fetch_order, |raw| {
                        let mut snap = [<$name Value>]::new(raw);
                        f(&mut snap);
                        Some(snap.to_bits())
                    }).unwrap();
                    [<$name Value>]::new(raw_prev)
                }

                /// Conditionally updates the array using a CAS loop.
                #[inline]
                pub fn update_or_abort<F>(&self, set_order: $crate::Ordering, fetch_order: $crate::Ordering, mut f: F) -> Result<[<$name Value>], [<$name Value>]>
                where
                    F: FnMut(&mut [<$name Value>]) -> Option<()>
                {
                    self.0.fetch_update(set_order, fetch_order, |raw| {
                        let mut snap = [<$name Value>]::new(raw);
                        f(&mut snap).map(|_| snap.to_bits())
                    }).map(|raw| [<$name Value>]::new(raw))
                    .map_err(|raw| [<$name Value>]::new(raw))
                }
            }
        }
    };
}

#[macro_export]
#[doc(hidden)]
macro_rules! __atomic_bitarray_snapshot {
    ($vis:vis, $name:ident, $width:literal, $count:literal, unsigned, int_type) => {
        $crate::paste::paste! {
            $crate::bitarray! {
                #[doc = concat!("A non-atomic value snapshot of `", stringify!($name), "` used for batch updates.")]
                $vis struct [<$name Value>](u $width, $count);
            }
        }
    };
    ($vis:vis, $name:ident, $width:literal, $count:literal, signed, int_type) => {
        $crate::paste::paste! {
            $crate::bitarray! {
                #[doc = concat!("A non-atomic value snapshot of `", stringify!($name), "` used for batch updates.")]
                $vis struct [<$name Value>](i $width, $count);
            }
        }
    };
    ($vis:vis, $name:ident, $width:literal, $count:literal, unsigned, bool_type) => {
        $crate::paste::paste! {
            $crate::bitarray! {
                #[doc = concat!("A non-atomic value snapshot of `", stringify!($name), "` used for batch updates.")]
                $vis struct [<$name Value>](bool, $count);
            }
        }
    };
}