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
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

use core::fmt;

use crate::Context;
use crate::hint::MapHint;

use super::{Encode, Encoder, EntryEncoder};

/// Encoder for a map.
pub trait MapEncoder {
    /// Context associated with the encoder.
    type Cx: Context<Error = Self::Error>;
    /// Error associated with encoding.
    type Error;
    /// The mode of the encoder.
    type Mode: 'static;
    /// Encode the next pair.
    type EncodeEntry<'this>: EntryEncoder<Cx = Self::Cx, Error = Self::Error, Mode = Self::Mode>
    where
        Self: 'this;

    /// Access the context associated with the encoder.
    fn cx(&self) -> Self::Cx;

    /// Encode the next map entry.
    #[must_use = "Encoders must be consumed"]
    fn encode_entry(&mut self) -> Result<Self::EncodeEntry<'_>, Self::Error>;

    /// Simplified encoder for a map entry, which ensures that encoding is
    /// always finished.
    #[inline]
    fn encode_entry_fn<F>(&mut self, f: F) -> Result<(), Self::Error>
    where
        F: FnOnce(&mut Self::EncodeEntry<'_>) -> Result<(), Self::Error>,
    {
        let mut encoder = self.encode_entry()?;
        f(&mut encoder)?;
        encoder.finish_entry()
    }

    /// Insert a map entry.
    #[inline]
    fn insert_entry<F, S>(&mut self, key: F, value: S) -> Result<(), Self::Error>
    where
        F: Encode<Self::Mode>,
        S: Encode<Self::Mode>,
    {
        self.encode_entry()?.insert_entry(key, value)?;
        Ok(())
    }

    /// Encode a map entry.
    #[inline]
    fn as_encoder(&mut self) -> AsEncoder<'_, Self>
    where
        Self: Sized,
    {
        AsEncoder { encoder: self }
    }

    /// Finish encoding a map.
    fn finish_map(self) -> Result<(), Self::Error>;
}

/// Encoder for a map.
pub struct AsEncoder<'a, E>
where
    E: ?Sized,
{
    encoder: &'a mut E,
}

#[crate::trait_defaults(crate)]
impl<'a, E> Encoder for AsEncoder<'a, E>
where
    E: MapEncoder,
{
    type Cx = E::Cx;
    type Error = E::Error;
    type Mode = E::Mode;
    type EncodeMap = AsEncoderEncodeMap<'a, E>;

    #[inline]
    fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "a map")
    }

    #[inline]
    fn cx(&self) -> Self::Cx {
        self.encoder.cx()
    }

    #[inline]
    fn encode_map(self, _: impl MapHint) -> Result<Self::EncodeMap, Self::Error> {
        Ok(AsEncoderEncodeMap {
            encoder: self.encoder,
        })
    }
}

pub struct AsEncoderEncodeMap<'a, E>
where
    E: ?Sized,
{
    encoder: &'a mut E,
}

impl<E> MapEncoder for AsEncoderEncodeMap<'_, E>
where
    E: ?Sized + MapEncoder,
{
    type Cx = E::Cx;
    type Error = E::Error;
    type Mode = E::Mode;
    type EncodeEntry<'this>
        = E::EncodeEntry<'this>
    where
        Self: 'this;

    #[inline]
    fn cx(&self) -> Self::Cx {
        self.encoder.cx()
    }

    #[inline]
    fn encode_entry(&mut self) -> Result<Self::EncodeEntry<'_>, Self::Error> {
        self.encoder.encode_entry()
    }

    #[inline]
    fn finish_map(self) -> Result<(), Self::Error> {
        Ok(())
    }
}