aboutsummaryrefslogtreecommitdiff
path: root/src/ser/mod.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/ser/mod.rs')
-rw-r--r--src/ser/mod.rs772
1 files changed, 772 insertions, 0 deletions
diff --git a/src/ser/mod.rs b/src/ser/mod.rs
new file mode 100644
index 0000000..be4f3f2
--- /dev/null
+++ b/src/ser/mod.rs
@@ -0,0 +1,772 @@
+use std::io::Write;
+use std::u32;
+
+use serde;
+
+use byteorder::WriteBytesExt;
+
+use super::config::{IntEncoding, SizeLimit};
+use super::{Error, ErrorKind, Result};
+use config::{BincodeByteOrder, Options};
+use std::mem::size_of;
+
+/// An Serializer that encodes values directly into a Writer.
+///
+/// The specified byte-order will impact the endianness that is
+/// used during the encoding.
+///
+/// This struct should not be used often.
+/// For most cases, prefer the `encode_into` function.
+pub struct Serializer<W, O: Options> {
+ writer: W,
+ _options: O,
+}
+
+macro_rules! impl_serialize_literal {
+ ($ser_method:ident($ty:ty) = $write:ident()) => {
+ pub(crate) fn $ser_method(&mut self, v: $ty) -> Result<()> {
+ self.writer
+ .$write::<<O::Endian as BincodeByteOrder>::Endian>(v)
+ .map_err(Into::into)
+ }
+ };
+}
+
+impl<W: Write, O: Options> Serializer<W, O> {
+ /// Creates a new Serializer with the given `Write`r.
+ pub fn new(w: W, options: O) -> Serializer<W, O> {
+ Serializer {
+ writer: w,
+ _options: options,
+ }
+ }
+
+ pub(crate) fn serialize_byte(&mut self, v: u8) -> Result<()> {
+ self.writer.write_u8(v).map_err(Into::into)
+ }
+
+ impl_serialize_literal! {serialize_literal_u16(u16) = write_u16()}
+ impl_serialize_literal! {serialize_literal_u32(u32) = write_u32()}
+ impl_serialize_literal! {serialize_literal_u64(u64) = write_u64()}
+
+ serde_if_integer128! {
+ impl_serialize_literal!{serialize_literal_u128(u128) = write_u128()}
+ }
+}
+
+macro_rules! impl_serialize_int {
+ ($ser_method:ident($ty:ty) = $ser_int:ident()) => {
+ fn $ser_method(self, v: $ty) -> Result<()> {
+ O::IntEncoding::$ser_int(self, v)
+ }
+ };
+}
+
+impl<'a, W: Write, O: Options> serde::Serializer for &'a mut Serializer<W, O> {
+ type Ok = ();
+ type Error = Error;
+ type SerializeSeq = Compound<'a, W, O>;
+ type SerializeTuple = Compound<'a, W, O>;
+ type SerializeTupleStruct = Compound<'a, W, O>;
+ type SerializeTupleVariant = Compound<'a, W, O>;
+ type SerializeMap = Compound<'a, W, O>;
+ type SerializeStruct = Compound<'a, W, O>;
+ type SerializeStructVariant = Compound<'a, W, O>;
+
+ fn serialize_unit(self) -> Result<()> {
+ Ok(())
+ }
+
+ fn serialize_unit_struct(self, _: &'static str) -> Result<()> {
+ Ok(())
+ }
+
+ fn serialize_bool(self, v: bool) -> Result<()> {
+ self.serialize_byte(v as u8)
+ }
+
+ fn serialize_u8(self, v: u8) -> Result<()> {
+ self.serialize_byte(v)
+ }
+
+ impl_serialize_int! {serialize_u16(u16) = serialize_u16()}
+ impl_serialize_int! {serialize_u32(u32) = serialize_u32()}
+ impl_serialize_int! {serialize_u64(u64) = serialize_u64()}
+
+ fn serialize_i8(self, v: i8) -> Result<()> {
+ self.serialize_byte(v as u8)
+ }
+
+ impl_serialize_int! {serialize_i16(i16) = serialize_i16()}
+ impl_serialize_int! {serialize_i32(i32) = serialize_i32()}
+ impl_serialize_int! {serialize_i64(i64) = serialize_i64()}
+
+ serde_if_integer128! {
+ impl_serialize_int!{serialize_u128(u128) = serialize_u128()}
+ impl_serialize_int!{serialize_i128(i128) = serialize_i128()}
+ }
+
+ fn serialize_f32(self, v: f32) -> Result<()> {
+ self.writer
+ .write_f32::<<O::Endian as BincodeByteOrder>::Endian>(v)
+ .map_err(Into::into)
+ }
+
+ fn serialize_f64(self, v: f64) -> Result<()> {
+ self.writer
+ .write_f64::<<O::Endian as BincodeByteOrder>::Endian>(v)
+ .map_err(Into::into)
+ }
+
+ fn serialize_str(self, v: &str) -> Result<()> {
+ O::IntEncoding::serialize_len(self, v.len())?;
+ self.writer.write_all(v.as_bytes()).map_err(Into::into)
+ }
+
+ fn serialize_char(self, c: char) -> Result<()> {
+ self.writer
+ .write_all(encode_utf8(c).as_slice())
+ .map_err(Into::into)
+ }
+
+ fn serialize_bytes(self, v: &[u8]) -> Result<()> {
+ O::IntEncoding::serialize_len(self, v.len())?;
+ self.writer.write_all(v).map_err(Into::into)
+ }
+
+ fn serialize_none(self) -> Result<()> {
+ self.writer.write_u8(0).map_err(Into::into)
+ }
+
+ fn serialize_some<T: ?Sized>(self, v: &T) -> Result<()>
+ where
+ T: serde::Serialize,
+ {
+ self.writer.write_u8(1)?;
+ v.serialize(self)
+ }
+
+ fn serialize_seq(self, len: Option<usize>) -> Result<Self::SerializeSeq> {
+ let len = len.ok_or(ErrorKind::SequenceMustHaveLength)?;
+ O::IntEncoding::serialize_len(self, len)?;
+ Ok(Compound { ser: self })
+ }
+
+ fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple> {
+ Ok(Compound { ser: self })
+ }
+
+ fn serialize_tuple_struct(
+ self,
+ _name: &'static str,
+ _len: usize,
+ ) -> Result<Self::SerializeTupleStruct> {
+ Ok(Compound { ser: self })
+ }
+
+ fn serialize_tuple_variant(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ _len: usize,
+ ) -> Result<Self::SerializeTupleVariant> {
+ O::IntEncoding::serialize_u32(self, variant_index)?;
+ Ok(Compound { ser: self })
+ }
+
+ fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap> {
+ let len = len.ok_or(ErrorKind::SequenceMustHaveLength)?;
+ O::IntEncoding::serialize_len(self, len)?;
+ Ok(Compound { ser: self })
+ }
+
+ fn serialize_struct(self, _name: &'static str, _len: usize) -> Result<Self::SerializeStruct> {
+ Ok(Compound { ser: self })
+ }
+
+ fn serialize_struct_variant(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ _len: usize,
+ ) -> Result<Self::SerializeStructVariant> {
+ O::IntEncoding::serialize_u32(self, variant_index)?;
+ Ok(Compound { ser: self })
+ }
+
+ fn serialize_newtype_struct<T: ?Sized>(self, _name: &'static str, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(self)
+ }
+
+ fn serialize_newtype_variant<T: ?Sized>(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ value: &T,
+ ) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ O::IntEncoding::serialize_u32(self, variant_index)?;
+ value.serialize(self)
+ }
+
+ fn serialize_unit_variant(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ ) -> Result<()> {
+ O::IntEncoding::serialize_u32(self, variant_index)
+ }
+
+ fn is_human_readable(&self) -> bool {
+ false
+ }
+}
+
+pub(crate) struct SizeChecker<O: Options> {
+ pub options: O,
+ pub total: u64,
+}
+
+impl<O: Options> SizeChecker<O> {
+ fn add_raw(&mut self, size: u64) -> Result<()> {
+ self.options.limit().add(size)?;
+ self.total += size;
+
+ Ok(())
+ }
+
+ fn add_discriminant(&mut self, idx: u32) -> Result<()> {
+ let bytes = O::IntEncoding::u32_size(idx);
+ self.add_raw(bytes)
+ }
+
+ fn add_len(&mut self, len: usize) -> Result<()> {
+ let bytes = O::IntEncoding::len_size(len);
+ self.add_raw(bytes)
+ }
+}
+
+macro_rules! impl_size_int {
+ ($ser_method:ident($ty:ty) = $size_method:ident()) => {
+ fn $ser_method(self, v: $ty) -> Result<()> {
+ self.add_raw(O::IntEncoding::$size_method(v))
+ }
+ };
+}
+
+impl<'a, O: Options> serde::Serializer for &'a mut SizeChecker<O> {
+ type Ok = ();
+ type Error = Error;
+ type SerializeSeq = SizeCompound<'a, O>;
+ type SerializeTuple = SizeCompound<'a, O>;
+ type SerializeTupleStruct = SizeCompound<'a, O>;
+ type SerializeTupleVariant = SizeCompound<'a, O>;
+ type SerializeMap = SizeCompound<'a, O>;
+ type SerializeStruct = SizeCompound<'a, O>;
+ type SerializeStructVariant = SizeCompound<'a, O>;
+
+ fn serialize_unit(self) -> Result<()> {
+ Ok(())
+ }
+
+ fn serialize_unit_struct(self, _: &'static str) -> Result<()> {
+ Ok(())
+ }
+
+ fn serialize_bool(self, _: bool) -> Result<()> {
+ self.add_raw(1)
+ }
+
+ fn serialize_u8(self, _: u8) -> Result<()> {
+ self.add_raw(1)
+ }
+ fn serialize_i8(self, _: i8) -> Result<()> {
+ self.add_raw(1)
+ }
+
+ impl_size_int! {serialize_u16(u16) = u16_size()}
+ impl_size_int! {serialize_u32(u32) = u32_size()}
+ impl_size_int! {serialize_u64(u64) = u64_size()}
+ impl_size_int! {serialize_i16(i16) = i16_size()}
+ impl_size_int! {serialize_i32(i32) = i32_size()}
+ impl_size_int! {serialize_i64(i64) = i64_size()}
+
+ serde_if_integer128! {
+ impl_size_int!{serialize_u128(u128) = u128_size()}
+ impl_size_int!{serialize_i128(i128) = i128_size()}
+ }
+
+ fn serialize_f32(self, _: f32) -> Result<()> {
+ self.add_raw(size_of::<f32>() as u64)
+ }
+
+ fn serialize_f64(self, _: f64) -> Result<()> {
+ self.add_raw(size_of::<f64>() as u64)
+ }
+
+ fn serialize_str(self, v: &str) -> Result<()> {
+ self.add_len(v.len())?;
+ self.add_raw(v.len() as u64)
+ }
+
+ fn serialize_char(self, c: char) -> Result<()> {
+ self.add_raw(encode_utf8(c).as_slice().len() as u64)
+ }
+
+ fn serialize_bytes(self, v: &[u8]) -> Result<()> {
+ self.add_len(v.len())?;
+ self.add_raw(v.len() as u64)
+ }
+
+ fn serialize_none(self) -> Result<()> {
+ self.add_raw(1)
+ }
+
+ fn serialize_some<T: ?Sized>(self, v: &T) -> Result<()>
+ where
+ T: serde::Serialize,
+ {
+ self.add_raw(1)?;
+ v.serialize(self)
+ }
+
+ fn serialize_seq(self, len: Option<usize>) -> Result<Self::SerializeSeq> {
+ let len = len.ok_or(ErrorKind::SequenceMustHaveLength)?;
+
+ self.add_len(len)?;
+ Ok(SizeCompound { ser: self })
+ }
+
+ fn serialize_tuple(self, _len: usize) -> Result<Self::SerializeTuple> {
+ Ok(SizeCompound { ser: self })
+ }
+
+ fn serialize_tuple_struct(
+ self,
+ _name: &'static str,
+ _len: usize,
+ ) -> Result<Self::SerializeTupleStruct> {
+ Ok(SizeCompound { ser: self })
+ }
+
+ fn serialize_tuple_variant(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ _len: usize,
+ ) -> Result<Self::SerializeTupleVariant> {
+ self.add_raw(O::IntEncoding::u32_size(variant_index))?;
+ Ok(SizeCompound { ser: self })
+ }
+
+ fn serialize_map(self, len: Option<usize>) -> Result<Self::SerializeMap> {
+ let len = len.ok_or(ErrorKind::SequenceMustHaveLength)?;
+
+ self.add_len(len)?;
+ Ok(SizeCompound { ser: self })
+ }
+
+ fn serialize_struct(self, _name: &'static str, _len: usize) -> Result<Self::SerializeStruct> {
+ Ok(SizeCompound { ser: self })
+ }
+
+ fn serialize_struct_variant(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ _len: usize,
+ ) -> Result<Self::SerializeStructVariant> {
+ self.add_discriminant(variant_index)?;
+ Ok(SizeCompound { ser: self })
+ }
+
+ fn serialize_newtype_struct<V: serde::Serialize + ?Sized>(
+ self,
+ _name: &'static str,
+ v: &V,
+ ) -> Result<()> {
+ v.serialize(self)
+ }
+
+ fn serialize_unit_variant(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ ) -> Result<()> {
+ self.add_discriminant(variant_index)
+ }
+
+ fn serialize_newtype_variant<V: serde::Serialize + ?Sized>(
+ self,
+ _name: &'static str,
+ variant_index: u32,
+ _variant: &'static str,
+ value: &V,
+ ) -> Result<()> {
+ self.add_discriminant(variant_index)?;
+ value.serialize(self)
+ }
+
+ fn is_human_readable(&self) -> bool {
+ false
+ }
+}
+
+pub struct Compound<'a, W: 'a, O: Options + 'a> {
+ ser: &'a mut Serializer<W, O>,
+}
+
+impl<'a, W, O> serde::ser::SerializeSeq for Compound<'a, W, O>
+where
+ W: Write,
+ O: Options,
+{
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_element<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, W, O> serde::ser::SerializeTuple for Compound<'a, W, O>
+where
+ W: Write,
+ O: Options,
+{
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_element<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, W, O> serde::ser::SerializeTupleStruct for Compound<'a, W, O>
+where
+ W: Write,
+ O: Options,
+{
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, W, O> serde::ser::SerializeTupleVariant for Compound<'a, W, O>
+where
+ W: Write,
+ O: Options,
+{
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, W, O> serde::ser::SerializeMap for Compound<'a, W, O>
+where
+ W: Write,
+ O: Options,
+{
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_key<K: ?Sized>(&mut self, value: &K) -> Result<()>
+ where
+ K: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn serialize_value<V: ?Sized>(&mut self, value: &V) -> Result<()>
+ where
+ V: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, W, O> serde::ser::SerializeStruct for Compound<'a, W, O>
+where
+ W: Write,
+ O: Options,
+{
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, _key: &'static str, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, W, O> serde::ser::SerializeStructVariant for Compound<'a, W, O>
+where
+ W: Write,
+ O: Options,
+{
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, _key: &'static str, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+pub(crate) struct SizeCompound<'a, S: Options + 'a> {
+ ser: &'a mut SizeChecker<S>,
+}
+
+impl<'a, O: Options> serde::ser::SerializeSeq for SizeCompound<'a, O> {
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_element<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, O: Options> serde::ser::SerializeTuple for SizeCompound<'a, O> {
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_element<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, O: Options> serde::ser::SerializeTupleStruct for SizeCompound<'a, O> {
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, O: Options> serde::ser::SerializeTupleVariant for SizeCompound<'a, O> {
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, O: Options + 'a> serde::ser::SerializeMap for SizeCompound<'a, O> {
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_key<K: ?Sized>(&mut self, value: &K) -> Result<()>
+ where
+ K: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn serialize_value<V: ?Sized>(&mut self, value: &V) -> Result<()>
+ where
+ V: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, O: Options> serde::ser::SerializeStruct for SizeCompound<'a, O> {
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, _key: &'static str, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+
+impl<'a, O: Options> serde::ser::SerializeStructVariant for SizeCompound<'a, O> {
+ type Ok = ();
+ type Error = Error;
+
+ #[inline]
+ fn serialize_field<T: ?Sized>(&mut self, _key: &'static str, value: &T) -> Result<()>
+ where
+ T: serde::ser::Serialize,
+ {
+ value.serialize(&mut *self.ser)
+ }
+
+ #[inline]
+ fn end(self) -> Result<()> {
+ Ok(())
+ }
+}
+const TAG_CONT: u8 = 0b1000_0000;
+const TAG_TWO_B: u8 = 0b1100_0000;
+const TAG_THREE_B: u8 = 0b1110_0000;
+const TAG_FOUR_B: u8 = 0b1111_0000;
+const MAX_ONE_B: u32 = 0x80;
+const MAX_TWO_B: u32 = 0x800;
+const MAX_THREE_B: u32 = 0x10000;
+
+fn encode_utf8(c: char) -> EncodeUtf8 {
+ let code = c as u32;
+ let mut buf = [0; 4];
+ let pos = if code < MAX_ONE_B {
+ buf[3] = code as u8;
+ 3
+ } else if code < MAX_TWO_B {
+ buf[2] = (code >> 6 & 0x1F) as u8 | TAG_TWO_B;
+ buf[3] = (code & 0x3F) as u8 | TAG_CONT;
+ 2
+ } else if code < MAX_THREE_B {
+ buf[1] = (code >> 12 & 0x0F) as u8 | TAG_THREE_B;
+ buf[2] = (code >> 6 & 0x3F) as u8 | TAG_CONT;
+ buf[3] = (code & 0x3F) as u8 | TAG_CONT;
+ 1
+ } else {
+ buf[0] = (code >> 18 & 0x07) as u8 | TAG_FOUR_B;
+ buf[1] = (code >> 12 & 0x3F) as u8 | TAG_CONT;
+ buf[2] = (code >> 6 & 0x3F) as u8 | TAG_CONT;
+ buf[3] = (code & 0x3F) as u8 | TAG_CONT;
+ 0
+ };
+ EncodeUtf8 { buf, pos }
+}
+
+struct EncodeUtf8 {
+ buf: [u8; 4],
+ pos: usize,
+}
+
+impl EncodeUtf8 {
+ fn as_slice(&self) -> &[u8] {
+ &self.buf[self.pos..]
+ }
+}