musli-core 0.1.4

Core traits and types for the Müsli serialization 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

use crate::en::Encoder;

/// Trait governing how a type is encoded as a packed value.
///
/// Packed encodings are ones where data follow one after another, with no
/// "metadata" indicating when one value starts and another stops.
///
/// This is typically used automatically through the `#[musli(packed)]`
/// attribute through the [`Decode` derive].
///
/// [`Decode` derive]: https://docs.rs/musli/latest/musli/_help/derives/
///
/// # Examples
///
/// ```
/// use musli::Encode;
///
/// #[derive(Encode)]
/// struct PackedType {
///     #[musli(packed)]
///     data: (u32, u32),
/// }
/// ```
///
/// Implementing manually:
///
/// ```
/// use musli::{Encode, Encoder};
/// use musli::en::SequenceEncoder;
///
/// struct PackedType {
///     data: (u32, u32),
/// }
///
/// impl<M> Encode<M> for PackedType {
///     type Encode = Self;
///
///     #[inline]
///     fn encode<E>(&self, encoder: E) -> Result<(), E::Error>
///     where
///         E: Encoder,
///     {
///         let mut pack = encoder.encode_pack()?;
///         pack.push(&self.data.0);
///         pack.push(&self.data.1);
///         pack.finish_sequence()
///     }
///
///     #[inline]
///     fn as_encode(&self) -> &Self::Encode {
///         self
///     }
/// }
/// ```
pub trait EncodePacked<M> {
    /// Encode the given output as bytes.
    fn encode_packed<E>(&self, encoder: E) -> Result<(), E::Error>
    where
        E: Encoder<Mode = M>;

    /// The number of fields in the type.
    #[inline]
    fn size_hint(&self) -> Option<usize> {
        None
    }
}

impl<T, M> EncodePacked<M> for &T
where
    T: ?Sized + EncodePacked<M>,
{
    #[inline]
    fn encode_packed<E>(&self, encoder: E) -> Result<(), E::Error>
    where
        E: Encoder<Mode = M>,
    {
        (**self).encode_packed(encoder)
    }
}

impl<T, M> EncodePacked<M> for &mut T
where
    T: ?Sized + EncodePacked<M>,
{
    #[inline]
    fn encode_packed<E>(&self, encoder: E) -> Result<(), E::Error>
    where
        E: Encoder<Mode = M>,
    {
        (**self).encode_packed(encoder)
    }
}