// Tests for the serializer and deserializer are located in tests/serde_/mod.rs. // They can be run with `cargo test --features serde_tests`. use serde_base::ser; use std::fmt::Display; use std::str::FromStr; use {Date, Error, EventWriter, PlistEvent}; impl ser::Error for Error { fn custom(msg: T) -> Self { Error::Serde(msg.to_string()) } } pub struct Serializer { writer: W, // We don't want to serialize None if the Option is in a struct field as this is how null // fields are represented in plists. This is fragile but results in minimal code duplication. // TODO: This is fragile. Use distinct types instead. maybe_option_field_name: Option<&'static str>, expecting_date: bool } impl Serializer { pub fn new(writer: W) -> Serializer { Serializer { writer: writer, maybe_option_field_name: None, expecting_date: false } } fn emit(&mut self, event: PlistEvent) -> Result<(), Error> { // Write a waiting struct field name. // TODO: This is fragile. Use distinct types instead. if let Some(field_name) = self.maybe_option_field_name.take() { self.emit(PlistEvent::StringValue(field_name.to_owned()))?; } if self.expecting_date { panic!("Expecting date"); } Ok(self.writer.write(&event)?) } pub fn into_inner(self) -> W { self.writer } // Emit {key: value} fn single_key_dict(&mut self, key: String) -> Result<(), Error> { self.emit(PlistEvent::StartDictionary(Some(1)))?; self.emit(PlistEvent::StringValue(key))?; Ok(()) } fn single_key_dict_end(&mut self) -> Result<(), Error> { self.emit(PlistEvent::EndDictionary)?; Ok(()) } } impl<'a, W: EventWriter> ser::Serializer for &'a mut Serializer { type Ok = (); type Error = Error; type SerializeSeq = Compound<'a, W>; type SerializeTuple = Compound<'a, W>; type SerializeTupleStruct = Compound<'a, W>; type SerializeTupleVariant = Compound<'a, W>; type SerializeMap = Compound<'a, W>; type SerializeStruct = Compound<'a, W>; type SerializeStructVariant = Compound<'a, W>; fn serialize_bool(self, v: bool) -> Result<(), Self::Error> { self.emit(PlistEvent::BooleanValue(v)) } fn serialize_i8(self, v: i8) -> Result<(), Self::Error> { self.serialize_i64(v as i64) } fn serialize_i16(self, v: i16) -> Result<(), Self::Error> { self.serialize_i64(v as i64) } fn serialize_i32(self, v: i32) -> Result<(), Self::Error> { self.serialize_i64(v as i64) } fn serialize_i64(self, v: i64) -> Result<(), Self::Error> { self.emit(PlistEvent::IntegerValue(v)) } fn serialize_u8(self, v: u8) -> Result<(), Self::Error> { self.serialize_u64(v as u64) } fn serialize_u16(self, v: u16) -> Result<(), Self::Error> { self.serialize_u64(v as u64) } fn serialize_u32(self, v: u32) -> Result<(), Self::Error> { self.serialize_u64(v as u64) } fn serialize_u64(self, v: u64) -> Result<(), Self::Error> { self.emit(PlistEvent::IntegerValue(v as i64)) } fn serialize_f32(self, v: f32) -> Result<(), Self::Error> { self.serialize_f64(v as f64) } fn serialize_f64(self, v: f64) -> Result<(), Self::Error> { self.emit(PlistEvent::RealValue(v)) } fn serialize_char(self, v: char) -> Result<(), Self::Error> { self.emit(PlistEvent::StringValue(v.to_string())) } fn serialize_str(self, value: &str) -> Result<(), Self::Error> { if self.expecting_date { self.expecting_date = false; self.emit(PlistEvent::DateValue(Date::from_str(value).expect("Invalid date format"))) } else { self.emit(PlistEvent::StringValue(value.to_owned())) } } fn serialize_bytes(self, value: &[u8]) -> Result<(), Self::Error> { self.emit(PlistEvent::DataValue(value.to_owned())) } fn serialize_none(self) -> Result<(), Self::Error> { // Don't write a dict for None if the Option is a struct field. // TODO: This is fragile. Use distinct types instead. if let None = self.maybe_option_field_name.take() { self.single_key_dict("None".to_owned())?; self.serialize_unit()?; self.single_key_dict_end()?; } Ok(()) } fn serialize_some(self, value: &T) -> Result<(), Self::Error> { // Don't write a dict for None if the Option is a struct field. // Can't use the write in emit here in case there is a Some(None). // TODO: This is fragile. Use distinct types instead. if let Some(field_name) = self.maybe_option_field_name.take() { self.emit(PlistEvent::StringValue(field_name.to_owned()))?; value.serialize(&mut *self) } else { self.single_key_dict("Some".to_owned())?; value.serialize(&mut *self)?; self.single_key_dict_end() } } fn serialize_unit(self) -> Result<(), Self::Error> { // Emit empty string self.emit(PlistEvent::StringValue(String::new())) } fn serialize_unit_struct(self, _name: &'static str) -> Result<(), Self::Error> { self.serialize_unit() } fn serialize_unit_variant(self, _name: &'static str, _variant_index: u32, variant: &'static str) -> Result<(), Self::Error> { self.single_key_dict(variant.to_owned())?; self.serialize_unit()?; self.single_key_dict_end()?; Ok(()) } fn serialize_newtype_struct(self, _name: &'static str, value: &T) -> Result<(), Self::Error> { if _name == "PLIST-DATE" { self.expecting_date = true; } value.serialize(self) } fn serialize_newtype_variant(self, _name: &'static str, _variant_index: u32, variant: &'static str, value: &T) -> Result<(), Self::Error> { self.single_key_dict(variant.to_owned())?; value.serialize(&mut *self)?; self.single_key_dict_end() } fn serialize_seq(self, len: Option) -> Result { let len = len.map(|len| len as u64); self.emit(PlistEvent::StartArray(len))?; Ok(Compound { ser: self }) } fn serialize_tuple(self, len: usize) -> Result { self.serialize_seq(Some(len)) } fn serialize_tuple_struct(self, _name: &'static str, len: usize) -> Result { self.serialize_tuple(len) } fn serialize_tuple_variant(self, _name: &'static str, _variant_index: u32, variant: &'static str, len: usize) -> Result { self.single_key_dict(variant.to_owned())?; self.serialize_tuple(len) } fn serialize_map(self, len: Option) -> Result { let len = len.map(|len| len as u64); self.emit(PlistEvent::StartDictionary(len))?; Ok(Compound { ser: self }) } fn serialize_struct(self, _name: &'static str, _len: usize) -> Result { // The number of struct fields is not known as fields with None values are ignored. self.serialize_map(None) } fn serialize_struct_variant(self, name: &'static str, _variant_index: u32, variant: &'static str, len: usize) -> Result { self.single_key_dict(variant.to_owned())?; self.serialize_struct(name, len) } } #[doc(hidden)] pub struct Compound<'a, W: 'a + EventWriter> { ser: &'a mut Serializer, } impl<'a, W: EventWriter> ser::SerializeSeq for Compound<'a, W> { type Ok = (); type Error = Error; fn serialize_element(&mut self, value: &T) -> Result<(), Self::Error> { value.serialize(&mut *self.ser) } fn end(self) -> Result { self.ser.emit(PlistEvent::EndArray) } } impl<'a, W: EventWriter> ser::SerializeTuple for Compound<'a, W> { type Ok = (); type Error = Error; fn serialize_element(&mut self, value: &T) -> Result<(), Self::Error> { ::serialize_element(self, value) } fn end(self) -> Result { ::end(self) } } impl<'a, W: EventWriter> ser::SerializeTupleStruct for Compound<'a, W> { type Ok = (); type Error = Error; fn serialize_field(&mut self, value: &T) -> Result<(), Self::Error> { ::serialize_element(self, value) } fn end(self) -> Result { ::end(self) } } impl<'a, W: EventWriter> ser::SerializeTupleVariant for Compound<'a, W> { type Ok = (); type Error = Error; fn serialize_field(&mut self, value: &T) -> Result<(), Self::Error> { ::serialize_element(self, value) } fn end(self) -> Result { self.ser.emit(PlistEvent::EndArray)?; self.ser.single_key_dict_end() } } impl<'a, W: EventWriter> ser::SerializeMap for Compound<'a, W> { type Ok = (); type Error = Error; fn serialize_key(&mut self, key: &T) -> Result<(), Self::Error> { key.serialize(&mut *self.ser) } fn serialize_value(&mut self, value: &T) -> Result<(), Self::Error> { value.serialize(&mut *self.ser) } fn end(self) -> Result { self.ser.emit(PlistEvent::EndDictionary) } } impl<'a, W: EventWriter> ser::SerializeStruct for Compound<'a, W> { type Ok = (); type Error = Error; fn serialize_field(&mut self, key: &'static str, value: &T) -> Result<(), Self::Error> { // Don't write a dict for None if the Option is a struct field. // TODO: This is fragile. Use distinct types instead. self.ser.maybe_option_field_name = Some(key); value.serialize(&mut *self.ser) } fn end(self) -> Result { ::end(self) } } impl<'a, W: EventWriter> ser::SerializeStructVariant for Compound<'a, W> { type Ok = (); type Error = Error; fn serialize_field(&mut self, key: &'static str, value: &T) -> Result<(), Self::Error> { ::serialize_field(self, key, value) } fn end(self) -> Result { self.ser.emit(PlistEvent::EndDictionary)?; self.ser.single_key_dict_end() } }