alkahest 0.3.0

Fantastic serialization library with zero-overhead serialization and zero-copy deserialization
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
use core::{mem::size_of, num::TryFromIntError};

use crate::{
    buffer::Buffer,
    deserialize::{Deserialize, DeserializeError, Deserializer},
    formula::{BareFormula, Formula},
    serialize::{Serialize, Sizes},
};

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed8")]
pub type FixedUsizeType = u8;

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed16")]
pub type FixedUsizeType = u16;

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed32")]
pub type FixedUsizeType = u32;

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed64")]
pub type FixedUsizeType = u64;

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed8")]
pub type FixedIsizeType = i8;

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed16")]
pub type FixedIsizeType = i16;

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed32")]
pub type FixedIsizeType = i32;

/// Type used to represent sizes and offsets in serialized data.
#[cfg(feature = "fixed64")]
pub type FixedIsizeType = i64;

/// Type used to represent sizes and offsets in serialized data.
/// This places limitation on sequence sizes which practically is never hit.
/// `usize` itself is not portable and cannot be written into alkahest package.
#[repr(transparent)]
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct FixedUsize(FixedUsizeType);

impl FixedUsize {
    /// Truncates `usize` to `FixedUsizeType` without checking.
    #[must_use]
    #[inline(always)]
    pub fn truncate_unchecked(value: usize) -> Self {
        debug_assert!(FixedUsize::try_from(value).is_ok());
        FixedUsize(value as FixedUsizeType)
    }

    /// Converts to byte array in little endian.
    #[must_use]
    #[inline(always)]
    pub fn to_le_bytes(self) -> [u8; size_of::<Self>()] {
        self.0.to_le_bytes()
    }

    /// Converts from byte array in little endian.
    ///
    /// # Errors
    ///
    /// Returns `Err` if the byte array does not represent a valid `usize`.
    #[inline(always)]
    pub fn from_le_bytes(bytes: [u8; size_of::<Self>()]) -> Result<Self, TryFromIntError> {
        FixedUsizeType::from_le_bytes(bytes).try_into()
    }
}

impl TryFrom<usize> for FixedUsize {
    type Error = TryFromIntError;

    #[inline(always)]
    fn try_from(value: usize) -> Result<Self, TryFromIntError> {
        FixedUsizeType::try_from(value).map(FixedUsize)
    }
}

impl TryFrom<FixedUsizeType> for FixedUsize {
    type Error = TryFromIntError;

    #[inline(always)]
    fn try_from(value: FixedUsizeType) -> Result<Self, TryFromIntError> {
        usize::try_from(value)?;
        Ok(FixedUsize(value))
    }
}

impl From<FixedUsize> for usize {
    #[inline(always)]
    fn from(value: FixedUsize) -> Self {
        value.0 as usize
    }
}

impl From<FixedUsize> for FixedUsizeType {
    #[inline(always)]
    fn from(value: FixedUsize) -> Self {
        value.0
    }
}

impl Formula for FixedUsize {
    const MAX_STACK_SIZE: Option<usize> = Some(size_of::<FixedUsizeType>());
    const EXACT_SIZE: bool = true;
    const HEAPLESS: bool = true;
}

impl BareFormula for FixedUsize {}

impl Serialize<FixedUsize> for FixedUsize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        <FixedUsizeType as Serialize<FixedUsizeType>>::serialize(self.0, sizes, buffer)
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedUsizeType>()))
    }
}

impl Serialize<FixedUsize> for &FixedUsize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        <FixedUsizeType as Serialize<FixedUsizeType>>::serialize(self.0, sizes, buffer)
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedUsizeType>()))
    }
}

impl Serialize<FixedUsize> for usize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        Serialize::<FixedUsizeType>::serialize(
            FixedUsize::truncate_unchecked(self).0,
            sizes,
            buffer,
        )
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedUsizeType>()))
    }
}

impl Serialize<FixedUsize> for &usize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        Serialize::<FixedUsizeType>::serialize(
            FixedUsize::truncate_unchecked(*self).0,
            sizes,
            buffer,
        )
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedUsizeType>()))
    }
}

impl Deserialize<'_, FixedUsize> for FixedUsize {
    #[inline(always)]
    fn deserialize(de: Deserializer) -> Result<Self, DeserializeError> {
        let value = <FixedUsizeType as Deserialize<FixedUsizeType>>::deserialize(de)?;

        #[cfg(debug_assertions)]
        if usize::try_from(value).is_err() {
            return Err(DeserializeError::InvalidUsize(value));
        }

        Ok(FixedUsize(value))
    }

    #[inline(always)]
    fn deserialize_in_place(&mut self, de: Deserializer) -> Result<(), DeserializeError> {
        <FixedUsizeType as Deserialize<FixedUsizeType>>::deserialize_in_place(&mut self.0, de)
    }
}

impl Deserialize<'_, FixedUsize> for usize {
    #[inline(always)]
    fn deserialize(de: Deserializer) -> Result<Self, DeserializeError> {
        let value = <FixedUsizeType as Deserialize<FixedUsizeType>>::deserialize(de)?;

        #[cfg(debug_assertions)]
        if usize::try_from(value).is_err() {
            return Err(DeserializeError::InvalidUsize(value));
        }

        Ok(value as usize)
    }

    #[inline(always)]
    fn deserialize_in_place(&mut self, de: Deserializer) -> Result<(), DeserializeError> {
        *self = <Self as Deserialize<FixedUsize>>::deserialize(de)?;
        Ok(())
    }
}

/// Type used to represent sizes and offsets in serialized data.
/// This places limitation on sequence sizes which practically is never hit.
/// `usize` itself is not portable and cannot be written into alkahest package.
#[repr(transparent)]
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct FixedIsize(FixedIsizeType);

impl FixedIsize {
    /// Truncates `isize` to `FixedIsizeType` without checking.
    #[must_use]
    #[inline(always)]
    pub fn truncate_unchecked(value: isize) -> Self {
        debug_assert!(FixedIsize::try_from(value).is_ok());
        FixedIsize(value as FixedIsizeType)
    }

    /// Converts to byte array in little endian.
    #[must_use]
    #[inline(always)]
    pub fn to_le_bytes(self) -> [u8; size_of::<Self>()] {
        self.0.to_le_bytes()
    }

    /// Converts from byte array in little endian.
    ///
    /// # Errors
    ///
    /// Returns `Err` if the byte array does not represent a valid `isize`.
    #[inline(always)]
    pub fn from_le_bytes(bytes: [u8; size_of::<Self>()]) -> Result<Self, TryFromIntError> {
        FixedIsizeType::from_le_bytes(bytes).try_into()
    }
}

impl TryFrom<isize> for FixedIsize {
    type Error = TryFromIntError;

    #[inline(always)]
    fn try_from(value: isize) -> Result<Self, TryFromIntError> {
        FixedIsizeType::try_from(value).map(FixedIsize)
    }
}

impl TryFrom<FixedIsizeType> for FixedIsize {
    type Error = TryFromIntError;

    #[inline(always)]
    fn try_from(value: FixedIsizeType) -> Result<Self, TryFromIntError> {
        isize::try_from(value)?;
        Ok(FixedIsize(value))
    }
}

impl From<FixedIsize> for isize {
    #[inline(always)]
    fn from(value: FixedIsize) -> Self {
        value.0 as isize
    }
}

impl From<FixedIsize> for FixedIsizeType {
    #[inline(always)]
    fn from(value: FixedIsize) -> Self {
        value.0
    }
}

impl Formula for FixedIsize {
    const MAX_STACK_SIZE: Option<usize> = Some(size_of::<FixedIsizeType>());
    const EXACT_SIZE: bool = true;
    const HEAPLESS: bool = true;
}

impl BareFormula for FixedIsize {}

impl Serialize<FixedIsize> for FixedIsize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        <FixedIsizeType as Serialize<FixedIsizeType>>::serialize(self.0, sizes, buffer)
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedIsizeType>()))
    }
}

impl Serialize<FixedIsize> for &FixedIsize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        <FixedIsizeType as Serialize<FixedIsizeType>>::serialize(self.0, sizes, buffer)
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedIsizeType>()))
    }
}

impl Serialize<FixedIsize> for isize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        Serialize::<FixedIsizeType>::serialize(
            FixedIsize::truncate_unchecked(self).0,
            sizes,
            buffer,
        )
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedIsizeType>()))
    }
}

impl Serialize<FixedIsize> for &isize {
    #[inline(always)]
    fn serialize<B>(self, sizes: &mut Sizes, buffer: B) -> Result<(), B::Error>
    where
        B: Buffer,
    {
        Serialize::<FixedIsizeType>::serialize(
            FixedIsize::truncate_unchecked(*self).0,
            sizes,
            buffer,
        )
    }

    #[inline(always)]
    fn size_hint(&self) -> Option<Sizes> {
        Some(Sizes::with_stack(size_of::<FixedIsizeType>()))
    }
}

impl Deserialize<'_, FixedIsize> for FixedIsize {
    #[inline(always)]
    fn deserialize(de: Deserializer) -> Result<Self, DeserializeError> {
        let value = <FixedIsizeType as Deserialize<FixedIsizeType>>::deserialize(de)?;

        #[cfg(debug_assertions)]
        if isize::try_from(value).is_err() {
            return Err(DeserializeError::InvalidIsize(value));
        }

        Ok(FixedIsize(value))
    }

    #[inline(always)]
    fn deserialize_in_place(&mut self, de: Deserializer) -> Result<(), DeserializeError> {
        <FixedIsizeType as Deserialize<FixedIsizeType>>::deserialize_in_place(&mut self.0, de)
    }
}

impl Deserialize<'_, FixedIsize> for isize {
    #[inline(always)]
    fn deserialize(de: Deserializer) -> Result<Self, DeserializeError> {
        let value = <FixedIsizeType as Deserialize<FixedIsizeType>>::deserialize(de)?;

        #[cfg(debug_assertions)]
        if isize::try_from(value).is_err() {
            return Err(DeserializeError::InvalidIsize(value));
        }

        Ok(value as isize)
    }

    #[inline(always)]
    fn deserialize_in_place(&mut self, de: Deserializer) -> Result<(), DeserializeError> {
        *self = <Self as Deserialize<FixedIsize>>::deserialize(de)?;
        Ok(())
    }
}

/// Stack space occupied by sizes and addresses.
pub const SIZE_STACK: usize = size_of::<FixedUsize>();