serde_rw 1.0.2

Extend serde serializers and deserializers with the ability to read / write different file formats from / to files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use std::fmt::Write;
use std::fs::{read_to_string, write};
use std::path::Path;

use quick_xml::se::Serializer;
use serde::Serialize;
use serde::de::DeserializeOwned;

/// Allow deserialization from XML.
#[allow(clippy::module_name_repetitions)]
pub trait FromXml: DeserializeOwned {
    /// Deserializes an object from an XML file.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the deserialization fails.
    ///
    /// # Examples
    /// ```
    /// use serde_rw::FromXml;
    /// use serde::Deserialize;
    ///
    /// #[derive(Debug, Deserialize, Eq, PartialEq)]
    /// struct Person {
    ///     id: u32,
    ///     name: String,
    /// }
    ///
    /// #[cfg(feature = "xml")]
    /// {
    ///     assert_eq!(
    ///         Person::from_xml_file("./tests/person.xml").unwrap(),
    ///         Person {
    ///             id: 1337,
    ///             name: "John Doe".to_string(),
    ///         }
    ///     );
    /// }
    /// ```
    fn from_xml_file(filename: impl AsRef<Path>) -> crate::Result<Self> {
        <Self as FromXml>::from_xml_string(&read_to_string(filename)?)
    }

    /// Deserializes an object from an XML string.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the deserialization fails.
    ///
    /// # Examples
    /// ```
    /// use serde_rw::FromXml;
    /// use serde::Deserialize;
    ///
    /// #[derive(Debug, Deserialize, Eq, PartialEq)]
    /// struct Person {
    ///     id: u32,
    ///     name: String,
    /// }
    ///
    /// const XML: &str = "<person><id>1337</id><name>John Doe</name></person>";
    ///
    /// #[cfg(feature = "xml")]
    /// {
    ///     assert_eq!(
    ///         Person::from_xml_string(XML).unwrap(),
    ///         Person {
    ///             id: 1337,
    ///             name: "John Doe".to_string(),
    ///         }
    ///     );
    /// }
    /// ```
    fn from_xml_string(text: &str) -> crate::Result<Self> {
        Ok(quick_xml::de::from_str(text)?)
    }
}

/// Allow serialization to XML.
#[allow(clippy::module_name_repetitions)]
pub trait ToXml: Serialize {
    /// Write object as XML to a [writer](Write).
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the serialization fails.
    fn write_xml<W>(&self, writer: W) -> crate::Result<()>
    where
        W: Write,
    {
        Ok(quick_xml::se::to_writer(writer, self).map(drop)?)
    }

    /// Return object as serialized XML string.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the serialization fails.
    fn to_xml(&self) -> crate::Result<String> {
        Ok(quick_xml::se::to_string(self)?)
    }

    /// Return object as a pretty serialized XML string.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the serialization fails.
    fn to_xml_pretty(&self, indent_char: char, indent_size: usize) -> crate::Result<String> {
        let mut buffer = String::new();
        let mut serializer = Serializer::new(&mut buffer);
        serializer.indent(indent_char, indent_size);
        self.serialize(serializer)?;
        Ok(buffer)
    }

    /// Writes object as serialized XML string to a file.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the serialization fails.
    fn write_to_xml_file(&self, filename: impl AsRef<Path>) -> crate::Result<()> {
        Ok(write(filename, <Self as ToXml>::to_xml(self)?)?)
    }

    /// Writes object as a pretty serialized XML string to a file.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`](crate::Error) if the serialization fails.
    fn write_to_xml_file_pretty(
        &self,
        filename: impl AsRef<Path>,
        indent_char: char,
        indent_size: usize,
    ) -> crate::Result<()> {
        Ok(write(
            filename,
            <Self as ToXml>::to_xml_pretty(self, indent_char, indent_size)?,
        )?)
    }
}