mod map; mod plain; mod seq; mod tuple; use self::{ map::{MapSerializer, StructSerializer}, seq::SeqSeralizer, tuple::TupleSerializer, }; use crate::error::{Error, Result}; use log::debug; use serde::ser::Serialize; use std::{collections::HashMap, io::Write}; use xml::writer::{EmitterConfig, EventWriter, XmlEvent}; /// A convenience method for serializing some object to a buffer. /// /// # Examples /// /// ```rust /// # use serde::Serialize; /// # use serde_xml_rs::to_writer; /// #[derive(Serialize)] /// struct Person { /// name: String, /// age: u32, /// } /// /// # fn main() { /// let mut buffer = Vec::new(); /// let joe = Person {name: "Joe".to_string(), age: 42}; /// /// to_writer(&mut buffer, &joe).unwrap(); /// /// let serialized = String::from_utf8(buffer).unwrap(); /// println!("{}", serialized); /// # } /// ``` pub fn to_writer(writer: W, value: &S) -> Result<()> { let mut ser = Serializer::new(writer); value.serialize(&mut ser) } /// A convenience method for serializing some object to a string. /// /// # Examples /// /// ```rust /// # use serde::Serialize; /// # use serde_xml_rs::to_string; /// #[derive(Serialize)] /// struct Person { /// name: String, /// age: u32, /// } /// /// # fn main() { /// /// let joe = Person {name: "Joe".to_string(), age: 42}; /// let serialized = to_string(&joe).unwrap(); /// println!("{}", serialized); /// # } /// ``` pub fn to_string(value: &S) -> Result { // Create a buffer and serialize our nodes into it let mut writer = Vec::with_capacity(128); to_writer(&mut writer, value)?; // We then check that the serialized string is the same as what we expect let string = String::from_utf8(writer)?; Ok(string) } /// An XML `Serializer`. pub struct Serializer where W: Write, { writer: EventWriter, root: bool, current_tag: String, current_tag_attrs: Option>, } impl Serializer where W: Write, { fn new_from_writer(writer: EventWriter) -> Self { Self { writer, root: true, current_tag: "".into(), current_tag_attrs: None, } } pub fn new(writer: W) -> Self { Self::new_from_writer(EmitterConfig::new().create_writer(writer)) } fn next(&mut self, event: XmlEvent) -> Result<()> { self.writer.write(event)?; Ok(()) } fn characters(&mut self, s: &str) -> Result<()> { self.next(XmlEvent::characters(s)) } fn start_document(&mut self) -> Result<()> { self.next(XmlEvent::StartDocument { encoding: Default::default(), standalone: Default::default(), version: xml::common::XmlVersion::Version10, }) } fn open_root_tag(&mut self, name: &'static str) -> Result<()> { if self.root { self.root = false; self.start_document()?; self.open_tag(name)?; } Ok(()) } fn open_tag(&mut self, tag_name: &str) -> Result<()> { self.current_tag = tag_name.into(); self.current_tag_attrs = Some(HashMap::new()); Ok(()) } fn reopen_tag(&mut self) -> Result<()> { self.current_tag_attrs = Some(HashMap::new()); Ok(()) } fn abandon_tag(&mut self) -> Result<()> { self.current_tag = "".into(); self.current_tag_attrs = None; Ok(()) } fn add_attr(&mut self, name: &'static str, value: String) -> Result<()> { self.current_tag_attrs .as_mut() .ok_or(Error::Custom { field: format!("Cannot add attribute {}", name), }) .map(|attrs| { attrs.insert(name, value); }) } fn build_start_tag(&mut self) -> Result { if let Some(attrs) = self.current_tag_attrs.take() { self.start_tag(&self.current_tag(), attrs)?; Ok(true) } else { Ok(false) } } fn start_tag(&mut self, tag_name: &str, attrs: HashMap<&str, String>) -> Result<()> { let element = attrs .iter() .fold(XmlEvent::start_element(tag_name), |b, (&name, value)| { b.attr(name, value) }); self.next(element.into()) } fn end_tag(&mut self) -> Result<()> { self.next(XmlEvent::end_element().into()) } fn current_tag(&self) -> String { self.current_tag.clone() } } impl<'ser, W: Write> serde::ser::Serializer for &'ser mut Serializer { type Ok = (); type Error = Error; type SerializeSeq = SeqSeralizer<'ser, W>; type SerializeTuple = TupleSerializer<'ser, W>; type SerializeTupleStruct = TupleSerializer<'ser, W>; type SerializeTupleVariant = TupleSerializer<'ser, W>; type SerializeMap = MapSerializer<'ser, W>; type SerializeStruct = StructSerializer<'ser, W>; type SerializeStructVariant = StructSerializer<'ser, W>; fn serialize_bool(self, v: bool) -> Result { self.serialize_str(&v.to_string()) } fn serialize_i8(self, v: i8) -> Result { self.serialize_i64(i64::from(v)) } fn serialize_i16(self, v: i16) -> Result { self.serialize_i64(i64::from(v)) } fn serialize_i32(self, v: i32) -> Result { self.serialize_i64(i64::from(v)) } fn serialize_i64(self, v: i64) -> Result { self.serialize_str(&v.to_string()) } fn serialize_u8(self, v: u8) -> Result { self.serialize_u64(u64::from(v)) } fn serialize_u16(self, v: u16) -> Result { self.serialize_u64(u64::from(v)) } fn serialize_u32(self, v: u32) -> Result { self.serialize_u64(u64::from(v)) } fn serialize_u64(self, v: u64) -> Result { let must_close_tag = self.build_start_tag()?; self.characters(&v.to_string())?; if must_close_tag { self.end_tag()?; } Ok(()) } fn serialize_f32(self, v: f32) -> Result { self.serialize_f64(f64::from(v)) } fn serialize_f64(self, v: f64) -> Result { self.serialize_str(&v.to_string()) } fn serialize_char(self, v: char) -> Result { self.serialize_str(&v.to_string()) } fn serialize_str(self, v: &str) -> Result { let must_close_tag = self.build_start_tag()?; self.characters(v)?; if must_close_tag { self.end_tag()?; } Ok(()) } fn serialize_bytes(self, _v: &[u8]) -> Result { unimplemented!() } fn serialize_none(self) -> Result { debug!("None"); let must_close_tag = self.build_start_tag()?; if must_close_tag { self.end_tag()?; } Ok(()) } fn serialize_some(self, value: &T) -> Result where T: Serialize, { debug!("Some"); value.serialize(self) } fn serialize_unit(self) -> Result { debug!("Unit"); let must_close_tag = self.build_start_tag()?; if must_close_tag { self.end_tag()?; } Ok(()) } fn serialize_unit_struct(self, name: &'static str) -> Result { debug!("Unit struct {}", name); self.serialize_unit() } fn serialize_unit_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, ) -> Result { debug!("Unit variant {}::{}", name, variant); self.start_tag(variant, HashMap::new())?; self.serialize_unit()?; self.end_tag()?; Ok(()) } fn serialize_newtype_struct(self, name: &'static str, value: &T) -> Result where T: Serialize, { debug!("Newtype struct {}", name); value.serialize(self) } fn serialize_newtype_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, value: &T, ) -> Result where T: Serialize, { let must_close_tag = self.build_start_tag()?; debug!("Newtype variant {}::{}", name, variant); self.open_tag(variant)?; value.serialize(&mut *self)?; if must_close_tag { self.end_tag()?; } Ok(()) } fn serialize_seq(self, _len: Option) -> Result { debug!("Sequence"); Ok(SeqSeralizer::new(self)) } fn serialize_tuple(self, _len: usize) -> Result { debug!("Tuple"); let must_close_tag = self.build_start_tag()?; Ok(TupleSerializer::new(self, must_close_tag)) } fn serialize_tuple_struct( self, name: &'static str, _len: usize, ) -> Result { debug!("Tuple struct {}", name); let must_close_tag = self.build_start_tag()?; Ok(TupleSerializer::new(self, must_close_tag)) } fn serialize_tuple_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, _len: usize, ) -> Result { debug!("Tuple variant {}::{}", name, variant); let must_close_tag = self.build_start_tag()?; self.start_tag(variant, HashMap::new())?; Ok(TupleSerializer::new(self, must_close_tag)) } fn serialize_map(self, _len: Option) -> Result { let must_close_tag = self.build_start_tag()?; Ok(MapSerializer::new(self, must_close_tag)) } fn serialize_struct(self, name: &'static str, _len: usize) -> Result { self.open_root_tag(name)?; debug!("Struct {}", name); Ok(StructSerializer::new(self, false)) } fn serialize_struct_variant( self, name: &'static str, _variant_index: u32, variant: &'static str, _len: usize, ) -> Result { self.open_root_tag(name)?; debug!("Struct variant {}", variant); let must_close_tag = self.build_start_tag()?; self.open_tag(variant)?; Ok(StructSerializer::new(self, must_close_tag)) } } #[cfg(test)] mod tests { use super::*; use serde::Serialize; #[test] fn test_serialize_struct() { #[derive(Serialize)] struct Person { name: String, age: u32, } let bob = Person { name: "Bob".to_string(), age: 42, }; let should_be = "Bob42"; let mut buffer = Vec::new(); { let mut ser = Serializer::new(&mut buffer); bob.serialize(&mut ser).unwrap(); } let got = String::from_utf8(buffer).unwrap(); assert_eq!(got, should_be); } #[test] fn test_serialize_enum() { #[derive(Serialize)] #[allow(dead_code)] enum Node { Boolean(bool), Number(f64), String(String), } let mut buffer = Vec::new(); let should_be = "true"; { let mut ser = Serializer::new(&mut buffer); let node = Node::Boolean(true); node.serialize(&mut ser).unwrap(); } let got = String::from_utf8(buffer).unwrap(); assert_eq!(got, should_be); } }