serde_rw 0.2.0

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

#[cfg(feature = "json")]
pub mod featured {
    use crate::Error;
    use serde::{Deserialize, Serialize};
    use std::fs::{read_to_string, write};
    use std::io::Write;

    pub trait FromJson<'de>: Deserialize<'de> {
        /// Deserializes an object from a JSON file
        /// # Arguments
        /// * `filename` - The path of the JSON file to be read
        ///
        /// # Errors
        /// * `serde_rw::Error` - If the file could not be read
        ///
        /// # Examples
        /// ```
        /// use serde_rw::FromFile;
        /// use serde::Deserialize;
        ///
        /// #[derive(Debug, Deserialize, Eq, PartialEq)]
        /// struct Person {
        ///     id: u32,
        ///     name: String,
        /// }
        ///
        /// #[cfg(feature = "json")]
        /// {
        ///     assert_eq!(
        ///         Person::from_json_file("./tests/person.json").unwrap(),
        ///         Person {
        ///             id: 1337,
        ///             name: "John Doe".to_string(),
        ///         }
        ///     );
        /// }
        /// ```
        fn from_json_file(filename: &str) -> Result<Self, Error> {
            read_to_string(filename)
                .map_err(Error::FileError)
                .and_then(|text| <Self as FromJson>::from_json_string(&text))
        }

        /// Deserializes an object from a JSON string
        /// # Arguments
        /// * `text` - A JSON file's content
        ///
        /// # Errors
        /// * `serde_rw::Error` - If the text could not be deserialized
        ///
        /// # Examples
        /// ```
        /// use serde_rw::FromFile;
        /// use serde::Deserialize;
        ///
        /// #[derive(Debug, Deserialize, Eq, PartialEq)]
        /// struct Person {
        ///     id: u32,
        ///     name: String,
        /// }
        ///
        /// const JSON: &str = r#"{"id": 1337, "name": "John Doe"}"#;
        ///
        /// #[cfg(feature = "json")]
        /// {
        ///     assert_eq!(
        ///         Person::from_json_string(JSON).unwrap(),
        ///         Person {
        ///             id: 1337,
        ///             name: "John Doe".to_string(),
        ///         }
        ///     );
        /// }
        /// ```
        fn from_json_string(text: &str) -> Result<Self, Error> {
            serde_json::from_str(text).map_err(|error| Error::SerdeError(error.to_string()))
        }
    }

    pub trait ToJson: Serialize {
        fn write_json<W>(&self, writer: W) -> Result<(), Error>
        where
            W: Write,
        {
            serde_json::to_writer(writer, self)
                .map_err(|error| Error::SerdeError(error.to_string()))
        }

        fn write_json_pretty<W>(&self, writer: W) -> Result<(), Error>
        where
            W: Write,
        {
            serde_json::to_writer_pretty(writer, self)
                .map_err(|error| Error::SerdeError(error.to_string()))
        }

        fn to_json(&self) -> Result<String, Error> {
            serde_json::to_string(self).map_err(|error| Error::SerdeError(error.to_string()))
        }

        fn write_to_json_file(&self, filename: &str) -> Result<(), Error> {
            write(filename, <Self as ToJson>::to_json(self)?).map_err(Error::FileError)
        }
    }
}