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    serde::serde_if_integer128! {
119        fn serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error> {
120            v.encode(self.enc)
121        }
122    }
123
124    fn serialize_u8(self, v: u8) -> Result<Self::Ok, Self::Error> {
125        v.encode(self.enc)
126    }
127
128    fn serialize_u16(self, v: u16) -> Result<Self::Ok, Self::Error> {
129        v.encode(self.enc)
130    }
131
132    fn serialize_u32(self, v: u32) -> Result<Self::Ok, Self::Error> {
133        v.encode(self.enc)
134    }
135
136    fn serialize_u64(self, v: u64) -> Result<Self::Ok, Self::Error> {
137        v.encode(self.enc)
138    }
139
140    serde::serde_if_integer128! {
141        fn serialize_u128(self, v: u128) -> Result<Self::Ok, Self::Error> {
142            v.encode(self.enc)
143        }
144    }
145
146    fn serialize_f32(self, v: f32) -> Result<Self::Ok, Self::Error> {
147        v.encode(self.enc)
148    }
149
150    fn serialize_f64(self, v: f64) -> Result<Self::Ok, Self::Error> {
151        v.encode(self.enc)
152    }
153
154    fn serialize_char(self, v: char) -> Result<Self::Ok, Self::Error> {
155        v.encode(self.enc)
156    }
157
158    fn serialize_str(self, v: &str) -> Result<Self::Ok, Self::Error> {
159        v.encode(self.enc)
160    }
161
162    fn serialize_bytes(self, v: &[u8]) -> Result<Self::Ok, Self::Error> {
163        v.encode(self.enc)
164    }
165
166    fn serialize_none(self) -> Result<Self::Ok, Self::Error> {
167        0u8.encode(self.enc)
168    }
169
170    fn serialize_some<T>(mut self, value: &T) -> Result<Self::Ok, Self::Error>
171    where
172        T: Serialize + ?Sized,
173    {
174        1u8.encode(&mut self.enc)?;
175        value.serialize(self)
176    }
177
178    fn serialize_unit(self) -> Result<Self::Ok, Self::Error> {
179        Ok(())
180    }
181
182    fn serialize_unit_struct(self, _name: &'static str) -> Result<Self::Ok, Self::Error> {
183        Ok(())
184    }
185
186    fn serialize_unit_variant(
187        self,
188        _name: &'static str,
189        variant_index: u32,
190        _variant: &'static str,
191    ) -> Result<Self::Ok, Self::Error> {
192        variant_index.encode(self.enc)
193    }
194
195    fn serialize_newtype_struct<T>(
196        self,
197        _name: &'static str,
198        value: &T,
199    ) -> Result<Self::Ok, Self::Error>
200    where
201        T: Serialize + ?Sized,
202    {
203        value.serialize(self)
204    }
205
206    fn serialize_newtype_variant<T>(
207        mut self,
208        _name: &'static str,
209        variant_index: u32,
210        _variant: &'static str,
211        value: &T,
212    ) -> Result<Self::Ok, Self::Error>
213    where
214        T: Serialize + ?Sized,
215    {
216        variant_index.encode(&mut self.enc)?;
217        value.serialize(self)
218    }
219
220    fn serialize_seq(mut self, len: Option<usize>) -> Result<Self::SerializeSeq, Self::Error> {
221        let len = len.ok_or_else(|| SerdeEncodeError::SequenceMustHaveLength.into())?;
222        len.encode(&mut self.enc)?;
223        Ok(Compound { enc: self.enc })
224    }
225
226    fn serialize_tuple(self, _: usize) -> Result<Self::SerializeTuple, Self::Error> {
227        Ok(self)
228    }
229
230    fn serialize_tuple_struct(
231        self,
232        _name: &'static str,
233        _len: usize,
234    ) -> Result<Self::SerializeTupleStruct, Self::Error> {
235        Ok(Compound { enc: self.enc })
236    }
237
238    fn serialize_tuple_variant(
239        mut self,
240        _name: &'static str,
241        variant_index: u32,
242        _variant: &'static str,
243        _len: usize,
244    ) -> Result<Self::SerializeTupleVariant, Self::Error> {
245        variant_index.encode(&mut self.enc)?;
246        Ok(Compound { enc: self.enc })
247    }
248
249    fn serialize_map(mut self, len: Option<usize>) -> Result<Self::SerializeMap, Self::Error> {
250        let len = len.ok_or_else(|| SerdeEncodeError::SequenceMustHaveLength.into())?;
251        len.encode(&mut self.enc)?;
252        Ok(Compound { enc: self.enc })
253    }
254
255    fn serialize_struct(
256        self,
257        _name: &'static str,
258        _len: usize,
259    ) -> Result<Self::SerializeStruct, Self::Error> {
260        Ok(Compound { enc: self.enc })
261    }
262
263    fn serialize_struct_variant(
264        mut self,
265        _name: &'static str,
266        variant_index: u32,
267        _variant: &'static str,
268        _len: usize,
269    ) -> Result<Self::SerializeStructVariant, Self::Error> {
270        variant_index.encode(&mut self.enc)?;
271        Ok(Compound { enc: self.enc })
272    }
273
274    #[cfg(not(feature = "alloc"))]
275    fn collect_str<T>(self, _: &T) -> Result<Self::Ok, Self::Error>
276    where
277        T: core::fmt::Display + ?Sized,
278    {
279        Err(SerdeEncodeError::CannotCollectStr.into())
280    }
281
282    fn is_human_readable(&self) -> bool {
283        false
284    }
285}
286
287type Compound<'a, ENC> = SerdeEncoder<'a, ENC>;
288
289impl<ENC: Encoder> SerializeSeq for Compound<'_, ENC> {
290    type Ok = ();
291    type Error = EncodeError;
292
293    fn serialize_element<T>(&mut self, value: &T) -> Result<(), Self::Error>
294    where
295        T: Serialize + ?Sized,
296    {
297        value.serialize(SerdeEncoder { enc: self.enc })
298    }
299
300    fn end(self) -> Result<Self::Ok, Self::Error> {
301        Ok(())
302    }
303}
304
305impl<ENC: Encoder> SerializeTuple for Compound<'_, ENC> {
306    type Ok = ();
307    type Error = EncodeError;
308
309    fn serialize_element<T>(&mut self, value: &T) -> Result<(), Self::Error>
310    where
311        T: Serialize + ?Sized,
312    {
313        value.serialize(SerdeEncoder { enc: self.enc })
314    }
315
316    fn end(self) -> Result<Self::Ok, Self::Error> {
317        Ok(())
318    }
319}
320
321impl<ENC: Encoder> SerializeTupleStruct for Compound<'_, ENC> {
322    type Ok = ();
323    type Error = EncodeError;
324
325    fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
326    where
327        T: Serialize + ?Sized,
328    {
329        value.serialize(SerdeEncoder { enc: self.enc })
330    }
331
332    fn end(self) -> Result<Self::Ok, Self::Error> {
333        Ok(())
334    }
335}
336
337impl<ENC: Encoder> SerializeTupleVariant for Compound<'_, ENC> {
338    type Ok = ();
339    type Error = EncodeError;
340
341    fn serialize_field<T>(&mut self, value: &T) -> Result<(), Self::Error>
342    where
343        T: Serialize + ?Sized,
344    {
345        value.serialize(SerdeEncoder { enc: self.enc })
346    }
347
348    fn end(self) -> Result<Self::Ok, Self::Error> {
349        Ok(())
350    }
351}
352
353impl<ENC: Encoder> SerializeMap for Compound<'_, ENC> {
354    type Ok = ();
355    type Error = EncodeError;
356
357    fn serialize_key<T>(&mut self, key: &T) -> Result<(), Self::Error>
358    where
359        T: Serialize + ?Sized,
360    {
361        key.serialize(SerdeEncoder { enc: self.enc })
362    }
363
364    fn serialize_value<T>(&mut self, value: &T) -> Result<(), Self::Error>
365    where
366        T: Serialize + ?Sized,
367    {
368        value.serialize(SerdeEncoder { enc: self.enc })
369    }
370
371    fn end(self) -> Result<Self::Ok, Self::Error> {
372        Ok(())
373    }
374}
375
376impl<ENC: Encoder> SerializeStruct for Compound<'_, ENC> {
377    type Ok = ();
378    type Error = EncodeError;
379
380    fn serialize_field<T>(&mut self, _key: &'static str, value: &T) -> Result<(), Self::Error>
381    where
382        T: Serialize + ?Sized,
383    {
384        value.serialize(SerdeEncoder { enc: self.enc })
385    }
386
387    fn end(self) -> Result<Self::Ok, Self::Error> {
388        Ok(())
389    }
390}
391
392impl<ENC: Encoder> SerializeStructVariant for Compound<'_, ENC> {
393    type Ok = ();
394    type Error = EncodeError;
395
396    fn serialize_field<T>(&mut self, _key: &'static str, value: &T) -> Result<(), Self::Error>
397    where
398        T: Serialize + ?Sized,
399    {
400        value.serialize(SerdeEncoder { enc: self.enc })
401    }
402
403    fn end(self) -> Result<Self::Ok, Self::Error> {
404        Ok(())
405    }
406}
bincode/features/serde/ser.rs

bincode/features/serde/
ser.rs
