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

use std::ffi::OsStr;
use std::path::Path;

use serde::Serialize;

use crate::Error;

#[cfg(feature = "xml")]
const XML_INDENT_CHAR: char = ' ';
#[cfg(feature = "xml")]
const XML_INDENT_LEN: usize = 4;

/// 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.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if the serialization fails.
    fn write_to_file(&self, filename: impl AsRef<Path>) -> crate::Result<()> {
        let extension = filename
            .as_ref()
            .extension()
            .map(OsStr::to_ascii_lowercase)
            .ok_or(Error::NoFileExtensionsSpecified)?;

        match extension.as_encoded_bytes() {
            #[cfg(feature = "json")]
            b"json" => <Self as crate::ToJson>::write_to_json_file(self, filename),
            #[cfg(feature = "toml")]
            b"toml" => <Self as crate::ToToml>::write_to_toml_file(self, filename),
            #[cfg(feature = "xml")]
            b"xml" => <Self as crate::ToXml>::write_to_xml_file(self, filename),
            #[cfg(feature = "yaml")]
            b"yml" | b"yaml" => <Self as crate::ToYaml>::write_to_yaml_file(self, filename),
            _ => Err(Error::UnsupportedFileExtension(extension)),
        }
    }

    /// Serializes an object into a prettified file dependent on its file extension.
    ///
    /// This will fall back to normal serialization if the given format does not support pretty printing.
    ///
    /// # Errors
    ///
    /// Returns an [`Error`] if the serialization fails.
    fn write_to_file_pretty(&self, filename: impl AsRef<Path>) -> crate::Result<()> {
        let extension = filename
            .as_ref()
            .extension()
            .map(OsStr::to_ascii_lowercase)
            .ok_or(Error::NoFileExtensionsSpecified)?;

        match extension.as_encoded_bytes() {
            #[cfg(feature = "json")]
            b"json" => <Self as crate::ToJson>::write_to_json_file_pretty(self, filename),
            #[cfg(feature = "xml")]
            b"xml" => <Self as crate::ToXml>::write_to_xml_file_pretty(
                self,
                filename,
                XML_INDENT_CHAR,
                XML_INDENT_LEN,
            ),
            _ => self.write_to_file(filename),
        }
    }
}

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 {}