bit_ops 0.2.3

Common bit-oriented operations on primitive integer types with a focus on `no_std` and `const` compatibility. Unlike other crates that provide tooling to create sophisticated high-level types with bitfields, the focus of `bit_ops` is on raw primitive integer types.
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

/*
MIT License

Copyright (c) 2025 Philipp Schuster

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
/// Implements the trait for the primitive type by forwarding all calls to
/// the function API.
macro_rules! impl_trait {
    ($primitive_ty:ty) => {
        impl BitOps for $primitive_ty {
            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::set_bit`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::set_bit`]: crate::bitops_", stringify!($primitive_ty), "::set_bit")]
            #[inline]
            fn set_bit(self, bit: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::set_bit(self, bit)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::set_bit_exact`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::set_bit_exact`]: crate::bitops_", stringify!($primitive_ty), "::set_bit_exact")]
            #[inline]
            fn set_bit_exact(self, bit: Self, value: bool) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::set_bit_exact(self, bit, value)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::clear_bit`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::clear_bit`]: crate::bitops_", stringify!($primitive_ty), "::clear_bit")]
            #[inline]
            fn clear_bit(self, bit: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::clear_bit(self, bit)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::is_set`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::is_set`]: crate::bitops_", stringify!($primitive_ty), "::is_set")]
            #[inline]
            fn is_set(self, bit: Self) -> bool {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::is_set(self, bit)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::get_bit`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::get_bit`]: crate::bitops_", stringify!($primitive_ty), "::get_bit")]
            #[inline]
            fn get_bit(self, bit: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::get_bit(self, bit)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::toggle_bit`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::toggle_bit`]: crate::bitops_", stringify!($primitive_ty), "::toggle_bit")]
            #[inline]
            fn toggle_bit(self, bit: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::toggle_bit(self, bit)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::toggle_bits`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::toggle_bits`]: crate::bitops_", stringify!($primitive_ty), "::toggle_bits")]
            #[inline]
            fn toggle_bits(self, bits: Self, shift: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::toggle_bits(self, bits, shift)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::set_bits`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::set_bits`]: crate::bitops_", stringify!($primitive_ty), "::set_bits")]
            #[inline]
            fn set_bits(self, value: Self, value_bits: Self, value_shift: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::set_bits(self, value, value_bits, value_shift)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::set_bits_n`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::set_bits_n`]: crate::bitops_", stringify!($primitive_ty), "::set_bits_n")]
            #[inline]
            fn set_bits_n(self, ops: &[(Self, Self, Self)]) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::set_bits_n(self, ops)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::set_bits_exact`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::set_bits_exact`]: crate::bitops_", stringify!($primitive_ty), "::set_bits_exact")]
            #[inline]
            fn set_bits_exact(self, value: Self, value_bits: Self, value_shift: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::set_bits_exact(self, value, value_bits, value_shift)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::set_bits_exact_n`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::set_bits_exact_n`]: crate::bitops_", stringify!($primitive_ty), "::set_bits_exact_n")]
            #[inline]
            fn set_bits_exact_n(self, ops: &[(Self, Self, Self)]) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::set_bits_exact_n(self, ops)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::clear_bits`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::clear_bits`]: crate::bitops_", stringify!($primitive_ty), "::clear_bits")]
            #[inline]
            fn clear_bits(self, clear_mask: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::clear_bits(self, clear_mask)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::highest_bit`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::highest_bit`]: crate::bitops_", stringify!($primitive_ty), "::highest_bit")]
            #[inline]
            fn highest_bit(self) -> Option<Self> {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::highest_bit(self)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::lowest_bit`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::lowest_bit`]: crate::bitops_", stringify!($primitive_ty), "::lowest_bit")]
            #[inline]
            fn lowest_bit(self) -> Option<Self> {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::lowest_bit(self)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::get_bits`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::get_bits`]: crate::bitops_", stringify!($primitive_ty), "::get_bits")]
            #[inline]
            fn get_bits(self, value_bits: Self, value_shift: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::get_bits(self, value_bits, value_shift)
                }
            }

            #[doc = concat!("Wrapper around [`bitops_", stringify!($primitive_ty), "::create_mask`],")]
            #[doc = concat!("but as associated function (method) on `", stringify!($primitive_ty), "`.")]
            #[doc = ""] // newline needed so that markdown links work
            #[doc = concat!("[`bitops_", stringify!($primitive_ty), "::create_mask`]: crate::bitops_", stringify!($primitive_ty), "::create_mask")]
            #[inline]
            fn create_mask(bits: Self) -> Self {
                paste::paste! {
                    $crate::[< bitops _ $primitive_ty >]::create_mask(bits)
                }
            }
        }
    };
}