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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
use crate::{
GeneralRendererSetting, RenderResult, renderer::general::error::GeneralRendererSerializeError,
};
use serde::Serialize;
pub mod error;
/// A general renderer that supports multiple serialization formats.
///
/// The `GeneralRenderer` provides methods to serialize data into various formats
/// including JSON, YAML, TOML, and RON, with support for both regular and
/// pretty-printed variants. It is designed to work with types that implement
/// the `Serialize` trait.
pub struct GeneralRenderer;
impl GeneralRenderer {
/// Renders data in the specified format to the given `RenderResult`.
///
/// # Errors
///
/// Returns `Err(GeneralRendererSerializeError)` if serialization fails.
#[allow(unused_variables)]
pub fn render<T: Serialize + Send>(
data: &T,
setting: &GeneralRendererSetting,
r: &mut RenderResult,
) -> Result<(), GeneralRendererSerializeError> {
match setting {
GeneralRendererSetting::Disable => Ok(()),
#[cfg(feature = "json_serde_fmt")]
GeneralRendererSetting::Json => Self::render_to_json(data, r),
#[cfg(feature = "json_serde_fmt")]
GeneralRendererSetting::JsonPretty => Self::render_to_json_pretty(data, r),
#[cfg(feature = "yaml_serde_fmt")]
GeneralRendererSetting::Yaml => Self::render_to_yaml(data, r),
#[cfg(feature = "toml_serde_fmt")]
GeneralRendererSetting::Toml => Self::render_to_toml(data, r),
#[cfg(feature = "ron_serde_fmt")]
GeneralRendererSetting::Ron => Self::render_to_ron(data, r),
#[cfg(feature = "ron_serde_fmt")]
GeneralRendererSetting::RonPretty => Self::render_to_ron_pretty(data, r),
}
}
/// Serializes data to JSON format and writes it to the render result.
///
/// # Errors
///
/// Returns `Err(GeneralRendererSerializeError)` if serialization fails.
#[cfg(feature = "json_serde_fmt")]
pub fn render_to_json<T: Serialize + Send>(
data: &T,
r: &mut RenderResult,
) -> Result<(), GeneralRendererSerializeError> {
let json_string = serde_json::to_string(data)
.map_err(|e| GeneralRendererSerializeError::new(e.to_string()))?;
r.print(json_string.clone().as_str());
Ok(())
}
/// Serializes data to pretty-printed JSON format and writes it to the render result.
///
/// # Errors
///
/// Returns `Err(GeneralRendererSerializeError)` if serialization fails.
#[cfg(feature = "json_serde_fmt")]
pub fn render_to_json_pretty<T: Serialize + Send>(
data: &T,
r: &mut RenderResult,
) -> Result<(), GeneralRendererSerializeError> {
let json_string = serde_json::to_string_pretty(data)
.map_err(|e| GeneralRendererSerializeError::new(e.to_string()))?;
r.print(json_string.clone().as_str());
Ok(())
}
/// Serializes data to RON format and writes it to the render result.
///
/// # Errors
///
/// Returns `Err(GeneralRendererSerializeError)` if serialization fails.
#[cfg(feature = "ron_serde_fmt")]
pub fn render_to_ron<T: Serialize + Send>(
data: &T,
r: &mut RenderResult,
) -> Result<(), GeneralRendererSerializeError> {
let ron_string = ron::ser::to_string(data)
.map_err(|e| GeneralRendererSerializeError::new(e.to_string()))?;
r.print(ron_string.to_string().as_str());
Ok(())
}
/// Serializes data to pretty-printed RON format and writes it to the render result.
///
/// # Errors
///
/// Returns `Err(GeneralRendererSerializeError)` if serialization fails.
#[cfg(feature = "ron_serde_fmt")]
pub fn render_to_ron_pretty<T: Serialize + Send>(
data: &T,
r: &mut RenderResult,
) -> Result<(), GeneralRendererSerializeError> {
let mut pretty_config = ron::ser::PrettyConfig::new();
pretty_config.new_line = std::borrow::Cow::from("\n");
pretty_config.indentor = std::borrow::Cow::from(" ");
let ron_string = ron::ser::to_string_pretty(data, pretty_config)
.map_err(|e| GeneralRendererSerializeError::new(e.to_string()))?;
r.print(ron_string.to_string().as_str());
Ok(())
}
/// Serializes data to TOML format and writes it to the render result.
///
/// # Errors
///
/// Returns `Err(GeneralRendererSerializeError)` if serialization fails.
#[cfg(feature = "toml_serde_fmt")]
pub fn render_to_toml<T: Serialize + Send>(
data: &T,
r: &mut RenderResult,
) -> Result<(), GeneralRendererSerializeError> {
let toml_string =
toml::to_string(data).map_err(|e| GeneralRendererSerializeError::new(e.to_string()))?;
r.print(toml_string.to_string().as_str());
Ok(())
}
/// Serializes data to YAML format and writes it to the render result.
///
/// # Errors
///
/// Returns `Err(GeneralRendererSerializeError)` if serialization fails.
#[cfg(feature = "yaml_serde_fmt")]
pub fn render_to_yaml<T: Serialize + Send>(
data: &T,
r: &mut RenderResult,
) -> Result<(), GeneralRendererSerializeError> {
let yaml_string = serde_yaml::to_string(data)
.map_err(|e| GeneralRendererSerializeError::new(e.to_string()))?;
r.print(yaml_string.to_string().as_str());
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::RenderResult;
use serde::Serialize;
#[derive(Debug, Clone, PartialEq, Serialize)]
struct TestData {
name: String,
value: i32,
}
fn test_data() -> TestData {
TestData {
name: "hello".into(),
value: 42,
}
}
#[test]
fn test_render_disable_does_nothing() {
let mut r = RenderResult::default();
let result =
GeneralRenderer::render(&test_data(), &GeneralRendererSetting::Disable, &mut r);
assert!(result.is_ok());
assert!(r.is_empty());
}
#[cfg(feature = "json_serde_fmt")]
#[test]
fn test_render_to_json() {
let mut r = RenderResult::default();
let result = GeneralRenderer::render_to_json(&test_data(), &mut r);
assert!(result.is_ok());
assert!(!r.is_empty());
let output: String = r.into();
assert!(output.contains("\"name\""));
assert!(output.contains("\"hello\""));
assert!(output.contains("\"value\""));
assert!(output.contains("42"));
}
#[cfg(feature = "json_serde_fmt")]
#[test]
fn test_render_to_json_pretty() {
let mut r = RenderResult::default();
let result = GeneralRenderer::render_to_json_pretty(&test_data(), &mut r);
assert!(result.is_ok());
let output: String = r.into();
// Pretty JSON has newlines
assert!(output.contains('\n'));
}
#[cfg(feature = "yaml_serde_fmt")]
#[test]
fn test_render_to_yaml() {
let mut r = RenderResult::default();
let result = GeneralRenderer::render_to_yaml(&test_data(), &mut r);
assert!(result.is_ok());
assert!(!r.is_empty());
}
#[cfg(feature = "toml_serde_fmt")]
#[test]
fn test_render_to_toml() {
let mut r = RenderResult::default();
let result = GeneralRenderer::render_to_toml(&test_data(), &mut r);
assert!(result.is_ok());
assert!(!r.is_empty());
}
#[cfg(feature = "ron_serde_fmt")]
#[test]
fn test_render_to_ron() {
let mut r = RenderResult::default();
let result = GeneralRenderer::render_to_ron(&test_data(), &mut r);
assert!(result.is_ok());
assert!(!r.is_empty());
}
#[cfg(feature = "ron_serde_fmt")]
#[test]
fn test_render_to_ron_pretty() {
let mut r = RenderResult::default();
let result = GeneralRenderer::render_to_ron_pretty(&test_data(), &mut r);
assert!(result.is_ok());
let output: String = r.into();
assert!(output.contains('\n'));
}
#[test]
fn test_render_dispatches_correct_format() {
// Test that render dispatches to the right format handler
let mut r = RenderResult::default();
// Disable
let result =
GeneralRenderer::render(&test_data(), &GeneralRendererSetting::Disable, &mut r);
assert!(result.is_ok());
assert!(r.is_empty());
}
#[cfg(feature = "json_serde_fmt")]
#[test]
fn test_render_dispatches_json() {
let mut r = RenderResult::default();
let result = GeneralRenderer::render(&test_data(), &GeneralRendererSetting::Json, &mut r);
assert!(result.is_ok());
assert!(!r.is_empty());
}
}
|
