polyglot 0.2.1

A library for format-agnostic serialization
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

use serde::Serialize;

use crate::{Error, Format};

/// Serialize a struct in the given format, outputting a vector of bytes.
///
/// Obviously, only formats enabled with feature flags will be supported.
/// ## Example
/// ```
/// use polyglot::{ser, Format};
/// use serde::Serialize;
///
/// #[derive(Serialize)]
/// pub struct Person {
///     pub name: String
/// }
///
/// let p = Person{name: String::from("John")};
/// let out_bytes = ser::to_vec(&p, Format::TOML).unwrap();
/// ```
pub fn to_vec<T: Serialize>(val: &T, format: Format) -> crate::Result<Vec<u8>> {
    #[cfg(feature = "json_fmt")]
    {
        if format == Format::JSON {
            return Ok(serde_json::to_vec(val)?);
        }
    }

    #[cfg(feature = "msgpack_fmt")]
    {
        if format == Format::MsgPack {
            return Ok(rmp_serde::to_vec(val)?);
        }
    }

    #[cfg(feature = "toml_fmt")]
    {
        if format == Format::TOML {
            return Ok(toml::to_vec(val)?);
        }
    }

    #[cfg(feature = "yaml_fmt")]
    {
        if format == Format::YAML {
            return Ok(serde_yaml::to_vec(val)?);
        }
    }

    Err(Error::new("Library Error - Unimplemented Serialize"))
}

/// Serialize a struct in the given format, outputting a string.
///
/// Obviously, only formats enabled with feature flags will be supported.
///
/// # Errors
/// Serializing to a string using msgpack will return an error due to MessagePack being a binary
/// format.
///
/// # Examples
/// ```
/// use polyglot::{ser, Format};
/// use serde::Serialize;
///
/// #[derive(Serialize)]
/// pub struct Person {
///     pub name: String
/// }
///
/// let p = Person{name: String::from("John")};
/// let out_str = ser::to_string(&p, Format::JSON).unwrap();
/// assert_eq!(&out_str, "{\"name\":\"John\"}");
/// ```
pub fn to_string<T: Serialize>(val: &T, format: Format) -> crate::Result<String> {
    #[cfg(feature = "json_fmt")]
    {
        if format == Format::JSON {
            return Ok(serde_json::to_string(val)?);
        }
    }

    #[cfg(feature = "msgpack_fmt")]
    {
        if format == Format::MsgPack {
            return Err(Error::new(
                "MessagePack is a binary format. Serializing to string is unsupported.",
            ));
        }
    }

    #[cfg(feature = "toml_fmt")]
    {
        if format == Format::TOML {
            return Ok(toml::to_string(val)?);
        }
    }

    #[cfg(feature = "yaml_fmt")]
    {
        if format == Format::YAML {
            return Ok(serde_yaml::to_string(val)?);
        }
    }

    Err(Error::new("Library Error - Unimplemented Serialize"))
}

pub fn to_writer<T: Serialize, V: std::io::Write>(
    mut w: V,
    val: &T,
    format: Format,
) -> crate::Result<()> {
    #[cfg(feature = "json_fmt")]
    {
        if format == Format::JSON {
            serde_json::to_writer(w, val)?;
            return Ok(());
        }
    }

    #[cfg(feature = "yaml_fmt")]
    {
        if format == Format::YAML {
            serde_yaml::to_writer(w, val)?;
            return Ok(());
        }
    }

    let vec_data = crate::to_vec(val, format)?;
    w.write_all(&vec_data)?;
    Ok(())
}