hexga_encoding 0.0.11-beta.53

Encoding and I/O abstraction for loading, saving, and converting data with custom extensions and media types, with optional Serde integration.
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
138
139
140
141
142
143

use super::*;

pub trait ToRon: Serialize
{
    fn to_ron(&self) -> EncodeResult<String>
    {
        ron::ser::to_string_pretty(&self, ron::ser::PrettyConfig::default())
            .map_err(|e| EncodeError::markup::<Self>(Extension::RON, e))
    }
    #[allow(unused_mut)] // weird LSP error
    fn to_ron_with_writer<W: Write>(&self, mut writer: W) -> EncodeResult
    {
        ron::ser::to_writer_pretty(
            writer.to_fmt_writer(),
            &self,
            ron::ser::PrettyConfig::default(),
        )
        .map_err(|e| EncodeError::markup::<Self>(Extension::RON, e))
    }
}
impl<T> ToRon for T where T: Serialize {}

pub trait FromRon: for<'de> Deserialize<'de>
{
    fn from_ron_bytes(bytes: &[u8]) -> EncodeResult<Self>
    {
        Self::from_ron_with_reader(BufReader::new(bytes))
    }
    fn from_ron_with_reader<R: Read>(reader: R) -> EncodeResult<Self>
    {
        ron::de::from_reader(reader).map_err(|e| EncodeError::markup::<Self>(Extension::RON, e))
    }
    fn from_ron(ron: &str) -> EncodeResult<Self>
    {
        ron::de::from_str(ron).map_err(|e| EncodeError::markup::<Self>(Extension::RON, e))
    }
}
impl<T> FromRon for T where T: for<'de> Deserialize<'de> {}

pub trait ToJson: Serialize
{
    fn to_json(&self) -> EncodeResult<String>
    {
        serde_json::ser::to_string_pretty(&self)
            .map_err(|e| EncodeError::markup::<Self>(Extension::JSON, e))
    }
    fn to_json_with_writer<W: Write>(&self, writer: W) -> EncodeResult
    {
        serde_json::ser::to_writer_pretty(writer, &self)
            .map_err(|e| EncodeError::markup::<Self>(Extension::JSON, e))
    }
}
impl<T> ToJson for T where T: Serialize {}

pub trait FromJson: for<'de> Deserialize<'de>
{
    fn from_json_bytes(bytes: &[u8]) -> EncodeResult<Self>
    {
        Self::from_json_with_reader(BufReader::new(bytes))
    }
    fn from_json_with_reader<R: Read>(reader: R) -> EncodeResult<Self>
    {
        serde_json::de::from_reader(reader)
            .map_err(|e| EncodeError::markup::<Self>(Extension::JSON, e))
    }
    fn from_json(json: &str) -> EncodeResult<Self>
    {
        serde_json::de::from_str(json).map_err(|e| EncodeError::markup::<Self>(Extension::JSON, e))
    }
}
impl<T> FromJson for T where T: for<'de> Deserialize<'de> {}

pub trait ToXml: Serialize
{
    fn to_xml(&self) -> EncodeResult<String>
    {
        serde_xml_rs::ser::to_string(&self)
            .map_err(|e| EncodeError::markup::<Self>(Extension::XML, e))
    }
    fn to_xml_with_writer<W: Write>(&self, writer: W) -> EncodeResult
    {
        serde_xml_rs::ser::to_writer(writer, &self)
            .map_err(|e| EncodeError::markup::<Self>(Extension::XML, e))
    }
}
impl<T> ToXml for T where T: Serialize {}

pub trait FromXml: for<'de> Deserialize<'de>
{
    fn from_xml_bytes(bytes: &[u8]) -> EncodeResult<Self>
    {
        Self::from_xml_with_reader(BufReader::new(bytes))
    }
    fn from_xml_with_reader<R: Read>(reader: R) -> EncodeResult<Self>
    {
        serde_xml_rs::de::from_reader(reader)
            .map_err(|e| EncodeError::markup::<Self>(Extension::XML, e))
    }
    fn from_xml(xml: &str) -> EncodeResult<Self>
    {
        serde_xml_rs::de::from_str(xml).map_err(|e| EncodeError::markup::<Self>(Extension::XML, e))
    }
}
impl<T> FromXml for T where T: for<'de> Deserialize<'de> {}

/// TODO: replace bincode by [postcard](https://docs.rs/postcard/latest/postcard/) ?

/// Intended for short-term storage of data in a binary format, such as during data transfer.
///
/// Not suitable for long-term storage, as the implementation or encoding may change at any time.
pub trait ToTmpBin: Serialize
{
    /// Intended for short-term storage of data in a binary format, such as during data transfer.
    ///
    /// Not suitable for long-term storage, as the implementation or encoding may change at any time.
    fn to_tmp_bin(&self) -> EncodeResult<Vec<u8>>
    {
        bincode::serialize(self).map_err(|e| EncodeError::markup::<Self>(Extension::TMP_BIN, e))
    }
    /// Intended for short-term storage of data in a binary format, such as during data transfer.
    ///
    /// Not suitable for long-term storage, as the implementation or encoding may change at any time.
    fn to_tmp_bin_with_writer<W: Write>(&self, writer: W) -> EncodeResult
    {
        bincode::serialize_into(writer, self)
            .map_err(|e| EncodeError::markup::<Self>(Extension::TMP_BIN, e))
    }
}
impl<T> ToTmpBin for T where T: Serialize {}

pub trait FromTmpBin: for<'de> Deserialize<'de>
{
    fn from_tmp_bin_bytes(bytes: &[u8]) -> EncodeResult<Self>
    {
        bincode::deserialize(bytes).map_err(|e| EncodeError::markup::<Self>(Extension::TMP_BIN, e))
    }
    fn from_tmp_bin_with_reader<R: Read>(reader: R) -> EncodeResult<Self>
    {
        bincode::deserialize_from(reader)
            .map_err(|e| EncodeError::markup::<Self>(Extension::TMP_BIN, e))
    }
}
impl<T> FromTmpBin for T where T: for<'de> Deserialize<'de> {}