serde_rw 1.0.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
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

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

use serde::{Deserialize, Serialize};

/// Allow deserialization from JSON.
#[allow(clippy::module_name_repetitions)]
pub trait FromJson: for<'de> Deserialize<'de> {
    /// Deserializes an object from a JSON file
    ///
    /// # Arguments
    /// * `filename` - The path of the JSON file to be read
    ///
    /// # Errors
    /// * `anyhow::Error` - If the file could not be read
    ///
    /// # Examples
    /// ```
    /// use serde_rw::FromJson;
    /// 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: impl AsRef<Path>) -> crate::Result<Self> {
        <Self as FromJson>::from_json_string(&read_to_string(filename)?)
    }

    /// Deserializes an object from a JSON string
    ///
    /// # Arguments
    /// * `text` - A JSON file's content
    ///
    /// # Errors
    /// * `anyhow::Error` - If the text could not be deserialized
    ///
    /// # Examples
    /// ```
    /// use serde_rw::FromJson;
    /// 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) -> crate::Result<Self> {
        Ok(serde_json::from_str(text)?)
    }
}

/// Allow serialization to JSON.
#[allow(clippy::module_name_repetitions)]
pub trait ToJson: Serialize {
    /// Write object as JSON to a `std::io::Write`r
    ///
    /// # Errors
    /// Returns an `anyhow::Error` in case the serialization fails.
    fn write_json<W>(&self, writer: W) -> crate::Result<()>
    where
        W: Write,
    {
        Ok(serde_json::to_writer(writer, self)?)
    }

    /// Write object as pretty JSON to a `std::io::Write`
    ///
    /// # Errors
    /// Returns an `anyhow::Error` in case the serialization fails.
    fn write_json_pretty<W>(&self, writer: W) -> crate::Result<()>
    where
        W: Write,
    {
        Ok(serde_json::to_writer_pretty(writer, self)?)
    }

    /// Return object as serialized JSON string
    ///
    /// # Errors
    /// Returns an `anyhow::Error` in case the serialization fails.
    fn to_json(&self) -> crate::Result<String> {
        Ok(serde_json::to_string(self)?)
    }

    /// Return object as prettified JSON string
    ///
    /// # Errors
    /// Returns an `anyhow::Error` in case the serialization fails.
    fn to_json_pretty(&self) -> crate::Result<String> {
        Ok(serde_json::to_string_pretty(self)?)
    }

    /// Write object as serialized JSON string to a file
    ///
    /// # Errors
    /// Returns an `anyhow::Error` in case the serialization fails.
    fn write_to_json_file(&self, filename: impl AsRef<Path>) -> crate::Result<()> {
        Ok(write(filename, <Self as ToJson>::to_json(self)?)?)
    }

    /// Write object as serialized JSON string to a file
    ///
    /// # Errors
    /// Returns an `anyhow::Error` in case the serialization fails.
    fn write_to_json_file_pretty(&self, filename: impl AsRef<Path>) -> crate::Result<()> {
        Ok(write(filename, <Self as ToJson>::to_json_pretty(self)?)?)
    }
}