ecore 0.10.0

no_std bit-level integer types, bitfield structs/enums, ranged integers, and enum maps
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333

use core::{
    marker::PhantomData,
    ops::{Index, IndexMut},
};

use crate::{
    Array, EnumMap, MapEnum, PlainMapEnum,
    bitfld::{BitField, BitsCast, DynBitField, IntoBitField, PlainBitsCast},
    int::{BasicInt, BasicUInt, CInt},
};

#[repr(transparent)]
pub struct BitFieldElement<STRUCT, FLD, const START: u32, const INDEX: usize> {
    raw: STRUCT,
    mark: PhantomData<FLD>,
}

impl<const START: u32, const INDEX: usize, STRUCT: PlainBitsCast<Bits: BasicUInt>, FLD: BitsCast> BitFieldElement<STRUCT, FLD, START, INDEX> {
    fn raw(&self) -> <STRUCT::Bits as BasicInt>::Primary {
        STRUCT::into_underlying(self.raw)
    }

    /// Reads the field value from the bit-struct at the given array index.
    pub fn read(&self) -> FLD {
        FLD::from_underlying(self.raw() >> AryOp::<START, INDEX, STRUCT::Bits, FLD>::BEGIN)
    }

    /// Generates a new bit-struct value with the given field value at this array index.
    #[must_use]
    pub fn with(&self, fld: impl IntoBitField<FLD>) -> STRUCT {
        STRUCT::from_underlying(AryOp::<START, INDEX, STRUCT::Bits, FLD>::with_bits(self.raw(), IntoBitField::into_bit_field(fld)))
    }

    /// Returns a dynamic bit-field reference to this array element.
    pub const fn as_ref(&self) -> &DynBitField<FLD, STRUCT> {
        DynBitField::new(&self.raw, AryOp::<START, INDEX, STRUCT::Bits, FLD>::BEGIN)
    }

    /// Returns a mutable dynamic bit-field reference to this array element.
    pub const fn as_mut(&mut self) -> &mut DynBitField<FLD, STRUCT> {
        DynBitField::new_mut(&mut self.raw, AryOp::<START, INDEX, STRUCT::Bits, FLD>::BEGIN)
    }

    /// Writes the field value at this array index.
    pub fn write(&mut self, fld: FLD) {
        self.raw = self.with(fld);
    }
}

impl<const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, FLD: BitsCast, const N: usize> BitField<STRUCT, [FLD; N], START, LAST> {
    pub const fn cget<const INDEX: usize>(&self) -> &BitFieldElement<STRUCT, FLD, START, INDEX> {
        const { assert!(INDEX < N) }
        unsafe { core::mem::transmute(self) }
    }

    pub const fn get(&self, index: usize) -> Option<&DynBitField<FLD, STRUCT>> {
        if index < N { Some(unsafe { self.get_unchecked(index) }) } else { None }
    }

    pub const fn get_mut(&mut self, index: usize) -> Option<&mut DynBitField<FLD, STRUCT>> {
        if index < N { Some(unsafe { self.get_unchecked_mut(index) }) } else { None }
    }

    /// # Safety
    ///
    /// The caller must ensure `index < N`.
    pub const unsafe fn get_unchecked(&self, index: usize) -> &DynBitField<FLD, STRUCT> {
        DynBitField::new(&self.raw, START + index as u32 * FLD::BITS)
    }

    /// # Safety
    ///
    /// The caller must ensure `index < N`.
    pub const unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut DynBitField<FLD, STRUCT> {
        DynBitField::new_mut(&mut self.raw, START + index as u32 * FLD::BITS)
    }
}

impl<const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, FLD: BitsCast, const N: usize> Index<usize>
    for BitField<STRUCT, [FLD; N], START, LAST>
{
    type Output = DynBitField<FLD, STRUCT>;

    fn index(&self, index: usize) -> &Self::Output {
        self.get(index).unwrap()
    }
}

impl<const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, FLD: BitsCast, const N: usize> IndexMut<usize>
    for BitField<STRUCT, [FLD; N], START, LAST>
{
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        self.get_mut(index).unwrap()
    }
}

impl<STRUCT: PlainBitsCast<Bits: BasicUInt>, FLD: BitsCast, const N: usize> DynBitField<[FLD; N], STRUCT> {
    pub const fn get(&self, index: usize) -> Option<&DynBitField<FLD, STRUCT>> {
        if index < N { Some(unsafe { self.get_unchecked(index) }) } else { None }
    }

    pub const fn get_mut(&mut self, index: usize) -> Option<&mut DynBitField<FLD, STRUCT>> {
        if index < N { Some(unsafe { self.get_unchecked_mut(index) }) } else { None }
    }

    /// # Safety
    ///
    /// The caller must ensure `index < N`.
    pub const unsafe fn get_unchecked(&self, index: usize) -> &DynBitField<FLD, STRUCT> {
        DynBitField::new(&self.underlying, self.start_bit() + index as u32 * FLD::BITS)
    }

    /// # Safety
    ///
    /// The caller must ensure `index < N`.
    pub const unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut DynBitField<FLD, STRUCT> {
        let start_bit = self.start_bit() + index as u32 * FLD::BITS;
        DynBitField::new_mut(&mut self.underlying, start_bit)
    }
}

impl<STRUCT: PlainBitsCast<Bits: BasicUInt>, FLD: BitsCast, const N: usize> Index<usize> for DynBitField<[FLD; N], STRUCT> {
    type Output = DynBitField<FLD, STRUCT>;

    fn index(&self, index: usize) -> &Self::Output {
        self.get(index).unwrap()
    }
}

impl<STRUCT: PlainBitsCast<Bits: BasicUInt>, FLD: BitsCast, const N: usize> IndexMut<usize> for DynBitField<[FLD; N], STRUCT> {
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        self.get_mut(index).unwrap()
    }
}

impl<FLD: BitsCast, const N: usize> DynBitField<[FLD; N]> {
    pub const fn get(&self, index: usize) -> Option<&DynBitField<FLD>> {
        if index < N { Some(unsafe { self.get_unchecked(index) }) } else { None }
    }

    pub const fn get_mut(&mut self, index: usize) -> Option<&mut DynBitField<FLD>> {
        if index < N { Some(unsafe { self.get_unchecked_mut(index) }) } else { None }
    }

    /// # Safety
    ///
    /// The caller must ensure `index < N`.
    pub const unsafe fn get_unchecked(&self, index: usize) -> &DynBitField<FLD> {
        let meta = self.meta();
        let meta = meta.start_bit().const_with((meta.start_bit().const_read() as u32 + index as u32 * FLD::BITS) as u8);
        unsafe { &*DynBitField::new_ptr((&raw const self.underlying).cast(), meta) }
    }

    /// # Safety
    ///
    /// The caller must ensure `index < N`.
    pub const unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut DynBitField<FLD> {
        let meta = self.meta();
        let meta = meta.start_bit().const_with((meta.start_bit().const_read() as u32 + index as u32 * FLD::BITS) as u8);
        unsafe { &mut *DynBitField::new_mut_ptr((&raw mut self.underlying).cast(), meta) }
    }
}

impl<FLD: BitsCast, const N: usize> Index<usize> for DynBitField<[FLD; N]> {
    type Output = DynBitField<FLD>;

    fn index(&self, index: usize) -> &Self::Output {
        self.get(index).unwrap()
    }
}

impl<FLD: BitsCast, const N: usize> IndexMut<usize> for DynBitField<[FLD; N]> {
    fn index_mut(&mut self, index: usize) -> &mut Self::Output {
        self.get_mut(index).unwrap()
    }
}

impl<const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + PlainMapEnum, FLD: BitsCast>
    BitField<STRUCT, EnumMap<Ids, FLD>, START, LAST>
{
    pub const fn get(&self, ids: &Ids) -> &DynBitField<FLD, STRUCT> {
        let ids: <Ids as PlainMapEnum>::NatureInt = unsafe { core::mem::transmute_copy(ids) };
        DynBitField::new(&self.raw, START + CInt::cast_as::<_, u32>(ids) * FLD::BITS)
    }

    pub const fn get_mut(&mut self, ids: &Ids) -> &mut DynBitField<FLD, STRUCT> {
        let ids: <Ids as PlainMapEnum>::NatureInt = unsafe { core::mem::transmute_copy(ids) };
        DynBitField::new_mut(&mut self.raw, START + CInt::cast_as::<_, u32>(ids) * FLD::BITS)
    }
}

impl<const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>>, FLD: BitsCast> Index<Ids>
    for BitField<STRUCT, EnumMap<Ids, FLD>, START, LAST>
{
    type Output = DynBitField<FLD, STRUCT>;

    fn index(&self, index: Ids) -> &Self::Output {
        &self[&index]
    }
}

impl<const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>>, FLD: BitsCast> IndexMut<Ids>
    for BitField<STRUCT, EnumMap<Ids, FLD>, START, LAST>
{
    fn index_mut(&mut self, index: Ids) -> &mut Self::Output {
        &mut self[&index]
    }
}

impl<'id, const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + 'id, FLD: BitsCast>
    Index<&'id Ids> for BitField<STRUCT, EnumMap<Ids, FLD>, START, LAST>
{
    type Output = DynBitField<FLD, STRUCT>;

    fn index(&self, index: &'id Ids) -> &Self::Output {
        DynBitField::new(&self.raw, START + index.get_index() as u32 * FLD::BITS)
    }
}

impl<'id, const START: u32, const LAST: u32, STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + 'id, FLD: BitsCast>
    IndexMut<&'id Ids> for BitField<STRUCT, EnumMap<Ids, FLD>, START, LAST>
{
    fn index_mut(&mut self, index: &'id Ids) -> &mut Self::Output {
        DynBitField::new_mut(&mut self.raw, START + index.get_index() as u32 * FLD::BITS)
    }
}

impl<STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + PlainMapEnum, FLD: BitsCast> DynBitField<EnumMap<Ids, FLD>, STRUCT> {
    pub const fn get(&self, ids: &Ids) -> &DynBitField<FLD, STRUCT> {
        let ids: <Ids as PlainMapEnum>::NatureInt = unsafe { core::mem::transmute_copy(ids) };
        DynBitField::new(&self.underlying, self.start_bit() + CInt::cast_as::<_, u32>(ids) * FLD::BITS)
    }

    pub const fn get_mut(&mut self, ids: &Ids) -> &mut DynBitField<FLD, STRUCT> {
        let ids: <Ids as PlainMapEnum>::NatureInt = unsafe { core::mem::transmute_copy(ids) };
        let start_bit = self.start_bit() + CInt::cast_as::<_, u32>(ids) * FLD::BITS;
        DynBitField::new_mut(&mut self.underlying, start_bit)
    }
}

impl<'id, STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + 'id, FLD: BitsCast> Index<&'id Ids>
    for DynBitField<EnumMap<Ids, FLD>, STRUCT>
{
    type Output = DynBitField<FLD, STRUCT>;

    fn index(&self, index: &'id Ids) -> &Self::Output {
        DynBitField::new(&self.underlying, self.start_bit() + index.get_index() as u32 * FLD::BITS)
    }
}

impl<'id, STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + 'id, FLD: BitsCast> IndexMut<&'id Ids>
    for DynBitField<EnumMap<Ids, FLD>, STRUCT>
{
    fn index_mut(&mut self, index: &'id Ids) -> &mut Self::Output {
        let start_bit = self.start_bit() + index.get_index() as u32 * FLD::BITS;
        DynBitField::new_mut(&mut self.underlying, start_bit)
    }
}

impl<STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>>, FLD: BitsCast> Index<Ids> for DynBitField<EnumMap<Ids, FLD>, STRUCT> {
    type Output = DynBitField<FLD, STRUCT>;

    fn index(&self, index: Ids) -> &Self::Output {
        &self[&index]
    }
}

impl<STRUCT: PlainBitsCast<Bits: BasicUInt>, Ids: MapEnum<Array: Array<Map<FLD>: Copy>>, FLD: BitsCast> IndexMut<Ids>
    for DynBitField<EnumMap<Ids, FLD>, STRUCT>
{
    fn index_mut(&mut self, index: Ids) -> &mut Self::Output {
        &mut self[&index]
    }
}

impl<Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + PlainMapEnum, FLD: BitsCast> DynBitField<EnumMap<Ids, FLD>> {
    pub const fn get(&self, ids: &Ids) -> &DynBitField<FLD> {
        let ids: <Ids as PlainMapEnum>::NatureInt = unsafe { core::mem::transmute_copy(ids) };
        let meta = self.meta();
        let meta = meta.start_bit().const_with((meta.start_bit().const_read() as u32 + CInt::cast_as::<_, u32>(ids) * FLD::BITS) as u8);
        unsafe { &*DynBitField::new_ptr((&raw const self.underlying).cast(), meta) }
    }

    pub const fn get_mut(&mut self, ids: &Ids) -> &mut DynBitField<FLD> {
        let ids: <Ids as PlainMapEnum>::NatureInt = unsafe { core::mem::transmute_copy(ids) };
        let meta = self.meta();
        let meta = meta.start_bit().const_with((meta.start_bit().const_read() as u32 + CInt::cast_as::<_, u32>(ids) * FLD::BITS) as u8);
        unsafe { &mut *DynBitField::new_mut_ptr((&raw mut self.underlying).cast(), meta) }
    }
}

impl<'id, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + 'id, FLD: BitsCast> Index<&'id Ids> for DynBitField<EnumMap<Ids, FLD>> {
    type Output = DynBitField<FLD>;

    fn index(&self, index: &'id Ids) -> &Self::Output {
        let meta = self.meta();
        let meta = meta.start_bit().const_with((meta.start_bit().const_read() as u32 + index.get_index() as u32 * FLD::BITS) as u8);
        unsafe { &*DynBitField::new_ptr((&raw const self.underlying).cast(), meta) }
    }
}

impl<'id, Ids: MapEnum<Array: Array<Map<FLD>: Copy>> + 'id, FLD: BitsCast> IndexMut<&'id Ids> for DynBitField<EnumMap<Ids, FLD>> {
    fn index_mut(&mut self, index: &'id Ids) -> &mut Self::Output {
        let meta = self.meta();
        let meta = meta.start_bit().const_with((meta.start_bit().const_read() as u32 + index.get_index() as u32 * FLD::BITS) as u8);
        unsafe { &mut *DynBitField::new_mut_ptr((&raw mut self.underlying).cast(), meta) }
    }
}

impl<Ids: MapEnum<Array: Array<Map<FLD>: Copy>>, FLD: BitsCast> Index<Ids> for DynBitField<EnumMap<Ids, FLD>> {
    type Output = DynBitField<FLD>;

    fn index(&self, index: Ids) -> &Self::Output {
        &self[&index]
    }
}

impl<Ids: MapEnum<Array: Array<Map<FLD>: Copy>>, FLD: BitsCast> IndexMut<Ids> for DynBitField<EnumMap<Ids, FLD>> {
    fn index_mut(&mut self, index: Ids) -> &mut Self::Output {
        &mut self[&index]
    }
}

struct AryOp<const BITS_BEGIN: u32, const ID: usize, Under, FLD>(PhantomData<(Under, FLD)>);

impl<const BITS_BEGIN: u32, const ID: usize, Under: BasicUInt, FLD: BitsCast> AryOp<BITS_BEGIN, ID, Under, FLD> {
    const BEGIN: u32 = BITS_BEGIN + ID as u32 * FLD::BITS;
    const REMAIN_BITS: u32 = Under::Primary::BITS - FLD::BITS;
    fn with_bits(v: Under::Primary, bv: Under::Primary) -> Under::Primary {
        let mask = Under::Primary::ALL_ONE >> Self::REMAIN_BITS << Self::BEGIN;
        v & !mask | (bv << Self::BEGIN) & mask
    }
}