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

use std::path::Path;

use anyhow::anyhow;
use serde::Serialize;

use crate::functions::extension;

/// Makes an object capable of writing itself to a file of a specified format
pub trait ToFile: Serialize + Sized {
    /// Serializes an object into a file dependent on its file extension
    ///
    /// # Arguments
    /// * `filename` - The path of the file to be written to
    ///
    /// # Errors
    /// * `anyhow::Error` - if any serialization or I/O errors occur or the file format is not supported
    fn write_to_file(&self, filename: impl AsRef<Path>) -> anyhow::Result<()> {
        match extension(filename.as_ref())? {
            #[cfg(feature = "json")]
            "json" => <Self as crate::ToJson>::write_to_json_file(self, filename),
            #[cfg(feature = "toml")]
            "toml" => <Self as crate::ToToml>::write_to_toml_file(self, filename),
            #[cfg(feature = "xml")]
            "xml" => <Self as crate::ToXml>::write_to_xml_file(self, filename),
            #[cfg(feature = "yaml")]
            "yml" | "yaml" => <Self as crate::ToYaml>::write_to_yaml_file(self, filename),
            extension => Err(anyhow!("Unsupported extension: '{extension}'")),
        }
    }

    /// Serializes an object into a prettified file dependent on its file extension
    ///
    /// # Arguments
    /// * `filename` - The path of the file to be written to
    ///
    /// # Errors
    /// * `anyhow::Error` - if any serialization or I/O errors occur or the file format is not supported
    fn write_to_file_pretty(&self, filename: impl AsRef<Path>) -> anyhow::Result<()> {
        match extension(filename.as_ref())? {
            #[cfg(feature = "json")]
            "json" => <Self as crate::ToJson>::write_to_json_file_pretty(self, filename),
            #[cfg(feature = "xml")]
            "xml" => <Self as crate::ToXml>::write_to_xml_file_pretty(self, filename, ' ', 4),
            extension => Err(anyhow!("Unsupported extension: '{extension}'")),
        }
    }
}

impl<T> ToFile for T where T: Serialize {}
#[cfg(feature = "json")]
impl<T> crate::ToJson for T where T: ToFile {}
#[cfg(feature = "toml")]
impl<T> crate::ToToml for T where T: ToFile {}
#[cfg(feature = "xml")]
impl<T> crate::ToXml for T where T: ToFile {}
#[cfg(feature = "yaml")]
impl<T> crate::ToYaml for T where T: ToFile {}