epserde 0.13.1

ε-serde is an ε-copy (i.e., almost zero-copy) serialization/deserialization framework
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

/*
 * SPDX-FileCopyrightText: 2023 Inria
 * SPDX-FileCopyrightText: 2023 Sebastiano Vigna
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 */

//! Convenience implementation for references to slices.
//!
//! In theory all types serialized by ε-serde must not contain references.
//! However, we provide a convenience implementation that serializes references
//! to slices as boxed slices.
//!
//! Note, however, that you must deserialize the slice as a vector or as a
//! boxed slice, even when it appears as a type parameter; see the example in
//! the [crate-level documentation].
//!
//! We provide a type hash for `[T]` so that it can be used in [`PhantomData`].
//!
//! [crate-level documentation]: crate
//! [`PhantomData`]: core::marker::PhantomData

use core::hash::Hash;

use crate::prelude::*;
use ser::*;

#[cfg(not(feature = "std"))]
use alloc::boxed::Box;

// For use with PhantomData
impl<T: TypeHash> TypeHash for [T] {
    fn type_hash(hasher: &mut impl core::hash::Hasher) {
        "[]".hash(hasher);
        T::type_hash(hasher);
    }
}

// For use with PhantomData
impl<T: TypeHash> TypeHash for &[T] {
    fn type_hash(hasher: &mut impl core::hash::Hasher) {
        "&[]".hash(hasher);
        T::type_hash(hasher);
    }
}

// For use with PhantomData
impl<T: TypeHash> TypeHash for &mut [T] {
    fn type_hash(hasher: &mut impl core::hash::Hasher) {
        "&mut[]".hash(hasher);
        T::type_hash(hasher);
    }
}

unsafe impl<T> CopyType for &[T] {
    type Copy = Deep;
}

impl<T: ZeroCopy> SerHelper<Zero> for [T] {
    #[inline(always)]
    unsafe fn _ser_inner(&self, backend: &mut impl WriteWithNames) -> ser::Result<()> {
        unsafe { ser_slice_zero(backend, self) }
    }
}

impl<T: DeepCopy + SerInner> SerHelper<Deep> for [T] {
    #[inline(always)]
    unsafe fn _ser_inner(&self, backend: &mut impl WriteWithNames) -> ser::Result<()> {
        unsafe { ser_slice_deep(backend, self) }
    }
}

impl<T: CopyType + SerInner> SerInner for &[T]
where
    [T]: SerHelper<<T as CopyType>::Copy>,
{
    type SerType = Box<[T::SerType]>;
    const IS_ZERO_COPY: bool = false;

    unsafe fn _ser_inner(&self, backend: &mut impl WriteWithNames) -> ser::Result<()> {
        unsafe { SerHelper::_ser_inner(*self, backend) }
    }
}

unsafe impl<T> CopyType for &mut [T] {
    type Copy = Deep;
}

impl<T: CopyType + SerInner> SerInner for &mut [T]
where
    [T]: SerHelper<<T as CopyType>::Copy>,
{
    type SerType = Box<[T::SerType]>;
    const IS_ZERO_COPY: bool = false;

    unsafe fn _ser_inner(&self, backend: &mut impl WriteWithNames) -> ser::Result<()> {
        unsafe { SerHelper::_ser_inner(&**self, backend) }
    }
}