cu_bincode/features/serde/
ser.rs

1use super::EncodeError as SerdeEncodeError;
2use crate::{
3    config::Config,
4    enc::{write::Writer, Encode, Encoder},
5    error::EncodeError,
6};
7#[cfg(feature = "alloc")]
8use alloc::vec::Vec;
9use serde::ser::*;
10
11/// Encode the given value into a `Vec<u8>` with the given `Config`. See the [config] module for more information.
12///
13/// [config]: ../config/index.html
14#[cfg(feature = "alloc")]
15#[cfg_attr(docsrs, doc(cfg(feature = "alloc")))]
16pub fn encode_to_vec<E, C>(val: E, config: C) -> Result<Vec<u8>, EncodeError>
17where
18    E: Serialize,
19    C: Config,
20{
21    let mut encoder = crate::enc::EncoderImpl::new(crate::VecWriter::default(), config);
22    let serializer = SerdeEncoder { enc: &mut encoder };
23    val.serialize(serializer)?;
24    Ok(encoder.into_writer().collect())
25}
26
27/// Encode the given value into the given slice. Returns the amount of bytes that have been written.
28///
29/// See the [config] module for more information on configurations.
30///
31/// [config]: ../config/index.html
32pub fn encode_into_slice<E, C>(val: E, dst: &mut [u8], config: C) -> Result<usize, EncodeError>
33where
34    E: Serialize,
35    C: Config,
36{
37    let mut encoder =
38        crate::enc::EncoderImpl::new(crate::enc::write::SliceWriter::new(dst), config);
39    let serializer = SerdeEncoder { enc: &mut encoder };
40    val.serialize(serializer)?;
41    Ok(encoder.into_writer().bytes_written())
42}
43
44/// Encode the given value into a custom [Writer].
45///
46/// See the [config] module for more information on configurations.
47///
48/// [config]: ../config/index.html
49pub fn encode_into_writer<E: Serialize, W: Writer, C: Config>(
50    val: E,
51    writer: W,
52    config: C,
53) -> Result<(), EncodeError> {
54    let mut encoder = crate::enc::EncoderImpl::<_, C>::new(writer, config);
55    let serializer = SerdeEncoder { enc: &mut encoder };
56    val.serialize(serializer)?;
57    Ok(())
58}
59
60/// Encode the given value into any type that implements `std::io::Write`, e.g. `std::fs::File`, with the given `Config`.
61/// See the [config] module for more information.
62///
63/// [config]: ../config/index.html
64#[cfg_attr(docsrs, doc(cfg(feature = "std")))]
65#[cfg(feature = "std")]
66pub fn encode_into_std_write<E: Serialize, C: Config, W: std::io::Write>(
67    val: E,
68    dst: &mut W,
69    config: C,
70) -> Result<usize, EncodeError> {
71    let writer = crate::IoWriter::new(dst);
72    let mut encoder = crate::enc::EncoderImpl::<_, C>::new(writer, config);
73    let serializer = SerdeEncoder { enc: &mut encoder };
74    val.serialize(serializer)?;
75    Ok(encoder.into_writer().bytes_written())
76}
77
78pub(super) struct SerdeEncoder<'a, ENC: Encoder> {
79    pub(super) enc: &'a mut ENC,
80}
81
82impl<ENC> Serializer for SerdeEncoder<'_, ENC>
83where
84    ENC: Encoder,
85{
86    type Ok = ();
87
88    type Error = EncodeError;
89
90    type SerializeSeq = Self;
91    type SerializeTuple = Self;
92    type SerializeTupleStruct = Self;
93    type SerializeTupleVariant = Self;
94    type SerializeMap = Self;
95    type SerializeStruct = Self;
96    type SerializeStructVariant = Self;
97
98    fn serialize_bool(self, v: bool) -> Result<Self::Ok, Self::Error> {
99        v.encode(self.enc)
100    }
101
102    fn serialize_i8(self, v: i8) -> Result<Self::Ok, Self::Error> {
103        v.encode(self.enc)
104    }
105
106    fn serialize_i16(self, v: i16) -> Result<Self::Ok, Self::Error> {
107        v.encode(self.enc)
108    }
109
110    fn serialize_i32(self, v: i32) -> Result<Self::Ok, Self::Error> {
111        v.encode(self.enc)
112    }
113
114    fn serialize_i64(self, v: i64) -> Result<Self::Ok, Self::Error> {
115        v.encode(self.enc)
116    }
117
118    fn serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error> {
119        v.encode(self.enc)
120    }
121
122    fn serialize_u8(self, v: u8) -> Result<Self::Ok, Self::Error> {
123        v.encode(self.enc)
124    }
125
126    fn serialize_u16(self, v: u16) -> Result<Self::Ok, Self::Error> {
127        v.encode(self.enc)
128    }
129
130    fn serialize_u32(self, v: u32) -> Result<Self::Ok, Self::Error> {
131        v.encode(self.enc)
132    }
133
134    fn serialize_u64(self, v: u64) -> Result<Self::Ok, Self::Error> {
135        v.encode(self.enc)
136    }
137
138    fn serialize_u128(self, v: u128) -> Result<Self::Ok, Self::Error> {
139        v.encode(self.enc)
140    }
141
142    fn serialize_f32(self, v: f32) -> Result<Self::Ok, Self::Error> {
143        v.encode(self.enc)
144    }
145
146    fn serialize_f64(self, v: f64) -> Result<Self::Ok, Self::Error> {
147        v.encode(self.enc)
148    }
149
150    fn serialize_char(self, v: char) -> Result<Self::Ok, Self::Error> {
151        v.encode(self.enc)
152    }
153
154    fn serialize_str(self, v: &str) -> Result<Self::Ok, Self::Error> {
155        v.encode(self.enc)
156    }
157
158    fn serialize_bytes(self, v: &[u8]) -> Result<Self::Ok, Self::Error> {
159        v.encode(self.enc)
160    }
161
162    fn serialize_none(self) -> Result<Self::Ok, Self::Error> {
163        0u8.encode(self.enc)
164    }
165
166    fn serialize_some<T>(mut self, value: &T) -> Result<Self::Ok, Self::Error>
167    where
168        T: Serialize + ?Sized,
169    {
170        1u8.encode(&mut self.enc)?;
171        value.serialize(self)
172    }
173
174    fn serialize_unit(self) -> Result<Self::Ok, Self::Error> {
175        Ok(())
176    }
177
178    fn serialize_unit_struct(self, _name: &'static str) -> Result<Self::Ok, Self::Error> {
179        Ok(())
180    }
181
182    fn serialize_unit_variant(
183        self,
184        _name: &'static str,
185        variant_index: u32,
186        _variant: &'static str,
187    ) -> Result<Self::Ok, Self::Error> {
188        variant_index.encode(self.enc)
189    }
190
191    fn serialize_newtype_struct<T>(
192        self,
193        _name: &'static str,
194        value: &T,
195    ) -> Result<Self::Ok, Self::Error>
196    where
197        T: Serialize + ?Sized,
198    {
199        value.serialize(self)
200    }
201
202    fn serialize_newtype_variant<T>(
203        mut self,
204        _name: &'static str,
205        variant_index: u32,
206        _variant: &'static str,
207        value: &T,
208    ) -> Result<Self::Ok, Self::Error>
209    where
210        T: Serialize + ?Sized,
211    {
212        variant_index.encode(&mut self.enc)?;
213        value.serialize(self)
214    }
215
216    fn serialize_seq(mut self, len: Option<usize>) -> Result<Self::SerializeSeq, Self::Error> {
217        let len = len.ok_or_else(|| SerdeEncodeError::SequenceMustHaveLength.into())?;
218        len.encode(&mut self.enc)?;
219        Ok(Compound { enc: self.enc })
220    }
221
222    fn serialize_tuple(self, _: usize) -> Result<Self::SerializeTuple, Self::Error> {
223        Ok(self)
224    }
225
226    fn serialize_tuple_struct(
227        self,
228        _name: &'static str,
229        _len: usize,
230    ) -> Result<Self::SerializeTupleStruct, Self::Error> {
231        Ok(Compound { enc: self.enc })
232    }
233
234    fn serialize_tuple_variant(
235        mut self,
236        _name: &'static str,
237        variant_index: u32,
238        _variant: &'static str,
239        _len: usize,
240    ) -> Result<Self::SerializeTupleVariant, Self::Error> {
241        variant_index.encode(&mut self.enc)?;
242        Ok(Compound { enc: self.enc })
243    }
244
245    fn serialize_map(mut self, len: Option<usize>) -> Result<Self::SerializeMap, Self::Error> {
246        let len = len.ok_or_else(|| SerdeEncodeError::SequenceMustHaveLength.into())?;
247        len.encode(&mut self.enc)?;
248        Ok(Compound { enc: self.enc })
249    }
250
251    fn serialize_struct(
252        self,
253        _name: &'static str,
254        _len: usize,
255    ) -> Result<Self::SerializeStruct, Self::Error> {
256        Ok(Compound { enc: self.enc })
257    }
258
259    fn serialize_struct_variant(
260        mut self,
261        _name: &'static str,
262        variant_index: u32,
263        _variant: &'static str,
264        _len: usize,
265    ) -> Result<Self::SerializeStructVariant, Self::Error> {
266        variant_index.encode(&mut self.enc)?;
267        Ok(Compound { enc: self.enc })
268    }
269
270    #[cfg(not(feature = "alloc"))]
271    fn collect_str<T>(self, _: &T) -> Result<Self::Ok, Self::Error>
272    where
273        T: core::fmt::Display + ?Sized,
274    {
275        Err(SerdeEncodeError::CannotCollectStr.into())
276    }
277
278    fn is_human_readable(&self) -> bool {
279        false
280    }
281}
282
283type Compound<'a, ENC> = SerdeEncoder<'a, ENC>;
284
285impl<ENC: Encoder> SerializeSeq for Compound<'_, ENC> {
286    type Ok = ();
287    type Error = EncodeError;
288
289    fn serialize_element<T>(&mut self, value: &T) -> Result<(), Self::Error>
290    where
291        T: Serialize + ?Sized,
292    {
293        value.serialize(SerdeEncoder { enc: self.enc })
294    }
295
296    fn end(self) -> Result<Self::Ok, Self::Error> {
297        Ok(())
298    }
299}
300
301impl<ENC: Encoder> SerializeTuple for Compound<'_, ENC> {
302    type Ok = ();
303    type Error = EncodeError;
304
305    fn serialize_element<T>(&mut self, value: &T) -> Result<(), Self::Error>
306    where
307        T: Serialize + ?Sized,
308    {
309        value.serialize(SerdeEncoder { enc: self.enc })
310    }
311
312    fn end(self) -> Result<Self::Ok, Self::Error> {
313        Ok(())
314    }
315}
316
317impl<ENC: Encoder> SerializeTupleStruct for Compound<'_, ENC> {
318    type Ok = ();
319    type Error = EncodeError;
320
321    fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
322    where
323        T: Serialize + ?Sized,
324    {
325        value.serialize(SerdeEncoder { enc: self.enc })
326    }
327
328    fn end(self) -> Result<Self::Ok, Self::Error> {
329        Ok(())
330    }
331}
332
333impl<ENC: Encoder> SerializeTupleVariant for Compound<'_, ENC> {
334    type Ok = ();
335    type Error = EncodeError;
336
337    fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
338    where
339        T: Serialize + ?Sized,
340    {
341        value.serialize(SerdeEncoder { enc: self.enc })
342    }
343
344    fn end(self) -> Result<Self::Ok, Self::Error> {
345        Ok(())
346    }
347}
348
349impl<ENC: Encoder> SerializeMap for Compound<'_, ENC> {
350    type Ok = ();
351    type Error = EncodeError;
352
353    fn serialize_key<T>(&mut self, key: &T) -> Result<(), Self::Error>
354    where
355        T: Serialize + ?Sized,
356    {
357        key.serialize(SerdeEncoder { enc: self.enc })
358    }
359
360    fn serialize_value<T>(&mut self, value: &T) -> Result<(), Self::Error>
361    where
362        T: Serialize + ?Sized,
363    {
364        value.serialize(SerdeEncoder { enc: self.enc })
365    }
366
367    fn end(self) -> Result<Self::Ok, Self::Error> {
368        Ok(())
369    }
370}
371
372impl<ENC: Encoder> SerializeStruct for Compound<'_, ENC> {
373    type Ok = ();
374    type Error = EncodeError;
375
376    fn serialize_field<T>(&mut self, _key: &'static str, value: &T) -> Result<(), Self::Error>
377    where
378        T: Serialize + ?Sized,
379    {
380        value.serialize(SerdeEncoder { enc: self.enc })
381    }
382
383    fn end(self) -> Result<Self::Ok, Self::Error> {
384        Ok(())
385    }
386}
387
388impl<ENC: Encoder> SerializeStructVariant for Compound<'_, ENC> {
389    type Ok = ();
390    type Error = EncodeError;
391
392    fn serialize_field<T>(&mut self, _key: &'static str, value: &T) -> Result<(), Self::Error>
393    where
394        T: Serialize + ?Sized,
395    {
396        value.serialize(SerdeEncoder { enc: self.enc })
397    }
398
399    fn end(self) -> Result<Self::Ok, Self::Error> {
400        Ok(())
401    }
402}
cu_bincode/features/serde/ser.rs

cu_bincode/features/serde/
ser.rs
