serde_rw 0.2.4

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

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

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

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

    pub trait ToYaml: Serialize {
        /// Return object as serialized YAML string
        /// # Errors
        /// Returns an `serde_rw::Error` in case the serialization fails.
        fn to_yaml(&self) -> Result<String, Error> {
            serde_yaml::to_string(self).map_err(|error| Error::SerdeError(error.to_string()))
        }

        /// Writes object as serialized YAML string to a file
        /// # Errors
        /// Returns an `serde_rw::Error` in case the serialization fails.
        fn write_to_yaml_file(&self, filename: &str) -> Result<(), Error> {
            write(filename, <Self as ToYaml>::to_yaml(self)?).map_err(Error::FileError)
        }
    }
}