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
use crate::Style::{COMPACT, PRETTY};
use core::fmt::Debug;
use std::io;
use thiserror::Error;
#[derive(Error, Debug)]
pub enum Yaml2JsonError {
#[error(transparent)]
SerdeYamlError(#[from] serde_yaml::Error),
#[error(transparent)]
SerdeJsonError(#[from] serde_json::Error),
#[error(transparent)]
IOError(#[from] std::io::Error),
}
/// `Style` defines JSON output formats for `Yaml2Json`.
pub enum Style {
/// `Style::COMPACT` outputs JSON on a single line.
/// e.g. for the following YAML:
/// ```yaml
/// ---
/// hello: world
/// spec:
/// items:
/// - a
/// - b
/// ```
///
/// the JSON output will be:
/// ```json
/// {"hello":"world","spec":{"items":["a","b"]}}
/// ```
COMPACT,
/// `Style::PRETTY` outputs JSON on multiple lines, with automatic indentation.
/// e.g. for the following YAML:
/// ```yaml
/// ---
/// hello: world
/// spec:
/// items:
/// - a
/// - b
/// ```
///
/// the JSON output will be:
/// ```json
/// {
/// "hello": "world",
/// "spec": {
/// "items": [
/// "a",
/// "b"
/// ]
/// }
/// }
/// ```
PRETTY,
}
/// Yaml2Json can convert individual YAML documents into JSON. Each instance can be configured to
/// have different styles of output.
///
/// The JSON output can be returned as a string:
/// ```
/// use yaml2json_rs::{Yaml2Json, Style};
///
/// let y2j = Yaml2Json::new(Style::COMPACT);
/// let input = "hello: world";
/// let output = y2j.document_to_string(input).unwrap();
///
/// assert_eq!(output, r#"{"hello":"world"}"#);
/// ```
///
/// Or, the JSON output can be sent to a writer:
/// ```
/// use yaml2json_rs::{Yaml2Json, Style};
/// use std::io;
///
/// let y2j = Yaml2Json::new(Style::COMPACT);
/// let input = "hello: world";
/// let mut stdout = io::stdout();
///
/// y2j.document_to_writer(input, &mut stdout);
///
/// // {"hello":"world"}
/// ```
pub struct Yaml2Json {
style: Style,
}
impl Yaml2Json {
/// `new()` creates a new `Yaml2Json`. It expects you to provide an output `Style`.
/// ```
/// use yaml2json_rs::{Yaml2Json, Style};
///
/// let y2j_pretty = Yaml2Json::new(Style::PRETTY);
/// let y2j_compact = Yaml2Json::new(Style::COMPACT);
/// ```
pub fn new(style: Style) -> Self {
Self { style }
}
/// `document_to_string()` takes a YAML document &str and converts it to a JSON String.
/// ```
/// use yaml2json_rs::{Yaml2Json, Style};
///
/// let y2j = Yaml2Json::new(Style::COMPACT);
/// let input = "hello: world";
/// let output = y2j.document_to_string(input).unwrap();
///
/// assert_eq!(output, r#"{"hello":"world"}"#);
/// ```
pub fn document_to_string(&self, document: &str) -> Result<String, Yaml2JsonError> {
let s: serde_json::Value = serde_yaml::from_str(document)?;
let res = match self.style {
COMPACT => serde_json::to_string(&s),
PRETTY => serde_json::to_string_pretty(&s),
};
match res {
Ok(s) => Ok(s),
Err(e) => Err(e.into()),
}
}
/// `document_to_writer()` takes a YAML document string, converts it to JSON and sends the output
/// to the provided writer.
///
/// ```
/// use yaml2json_rs::{Yaml2Json, Style};
/// use std::io;
///
/// let y2j = Yaml2Json::new(Style::COMPACT);
/// let input = "hello: world";
/// let mut stdout = io::stdout();
///
/// y2j.document_to_writer(input, &mut stdout);
///
/// // {"hello":"world"}
/// ```
pub fn document_to_writer<W: io::Write>(
&self,
document: &str,
w: &mut W,
) -> Result<(), Yaml2JsonError> {
let s: serde_json::Value = serde_yaml::from_str(document)?;
let res = match self.style {
PRETTY => serde_json::to_writer_pretty(w, &s),
COMPACT => serde_json::to_writer(w, &s),
};
match res {
Ok(_) => Ok(()),
Err(e) => Err(e.into()),
}
}
}
#[cfg(test)]
mod tests {
use crate::{Style, Yaml2Json};
use std::io::Cursor;
#[test]
fn document_to_string_compact() {
let yaml2json = Yaml2Json::new(Style::COMPACT);
let input = r#"
---
abc: def
"#;
let expected = r#"{"abc":"def"}"#;
let res = yaml2json.document_to_string(input).unwrap();
assert_eq!(expected, res);
}
#[test]
fn document_to_string_pretty() {
let yaml2json = Yaml2Json::new(Style::PRETTY);
let input = r#"
---
abc: def
"#;
let expected = r#"{
"abc": "def"
}"#;
let res = yaml2json.document_to_string(input).unwrap();
assert_eq!(expected, res);
}
#[test]
fn document_to_writer_compact() {
let yaml2json = Yaml2Json::new(Style::COMPACT);
let input = r#"
---
abc: def
"#;
let expected = r#"{"abc":"def"}"#;
let mut buf = Cursor::new(Vec::<u8>::new());
yaml2json.document_to_writer(input, buf.get_mut()).unwrap();
let res = String::from_utf8(buf.into_inner()).unwrap();
assert_eq!(expected, res);
}
#[test]
fn document_to_writer_pretty() {
let yaml2json = Yaml2Json::new(Style::PRETTY);
let input = r#"
---
abc: def
"#;
let expected = r#"{
"abc": "def"
}"#;
let mut buf = Cursor::new(Vec::<u8>::new());
yaml2json.document_to_writer(input, buf.get_mut()).unwrap();
let res = String::from_utf8(buf.into_inner()).unwrap();
assert_eq!(expected, res);
}
}