yaml-subset 0.1.19

A subset of yaml used in rumbas
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
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
use serde::ser;
use serde::Serialize;

use super::string::{
    DoubleQuotedStringEscapedChar, DoubleQuotedStringPart, SingleQuotedStringEscapedChar,
    SingleQuotedStringPart,
};
use super::{AliasedYaml, ArrayData, HashData, HashElement, Yaml};

// ─── Error ───────────────────────────────────────────────────────────────────

#[derive(Debug)]
pub struct YamlSerializeError(pub String);

impl std::fmt::Display for YamlSerializeError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl std::error::Error for YamlSerializeError {}

impl ser::Error for YamlSerializeError {
    fn custom<T: std::fmt::Display>(msg: T) -> Self {
        YamlSerializeError(msg.to_string())
    }
}

// ─── Helpers ─────────────────────────────────────────────────────────────────

fn aliased(value: Yaml) -> AliasedYaml {
    AliasedYaml { alias: None, value }
}

// Returns true when a string cannot be written as a plain (unquoted) YAML scalar.
// Also quotes strings that are unsafe in inline (flow) context, since the serializer
// has no context. pretty() will de-quote back to unquoted in block context when safe.
// Also quotes strings that serde's untagged-enum Content mechanism misinterprets.
fn needs_quoting(s: &str) -> bool {
    !super::can_be_unquoted_in_block(s) || super::inline_breaking_chars(s)
}

// Returns the most readable Yaml scalar for a Rust string:
//   - UnquotedString when the grammar allows it (no special chars)
//   - SingleQuotedString when quoting is needed but no newlines (clean, no escapes)
//   - DoubleQuotedString with EscapedChar nodes for \n and \r, so that pretty()
//     can convert them to a LiteralString block; long plain strings become FoldedString.
fn str_to_yaml(s: &str) -> Yaml {
    if !needs_quoting(s) {
        return Yaml::UnquotedString(s.to_string());
    }
    if !s.contains('\n') && !s.contains('\r') {
        // Prefer single quotes unless the string contains ' but no " — then double quotes
        // avoid the '' doubling.
        if s.contains('\'') && !s.contains('"') {
            // Double-quoted: ' is fine unescaped, only \ needs escaping here.
            let mut parts: Vec<DoubleQuotedStringPart> = Vec::new();
            let mut buf = String::new();
            for ch in s.chars() {
                if ch == '\\' {
                    if !buf.is_empty() {
                        parts.push(DoubleQuotedStringPart::String(std::mem::take(&mut buf)));
                    }
                    parts.push(DoubleQuotedStringPart::EscapedChar(
                        DoubleQuotedStringEscapedChar::Backslash,
                    ));
                } else {
                    buf.push(ch);
                }
            }
            if !buf.is_empty() {
                parts.push(DoubleQuotedStringPart::String(buf));
            }
            return Yaml::DoubleQuotedString(parts);
        }
        // Single-quoted: handles ", \, and other special chars literally; ' is doubled.
        let mut parts: Vec<SingleQuotedStringPart> = Vec::new();
        let mut buf = String::new();
        for ch in s.chars() {
            if ch == '\'' {
                if !buf.is_empty() {
                    parts.push(SingleQuotedStringPart::String(std::mem::take(&mut buf)));
                }
                parts.push(SingleQuotedStringPart::EscapedChar(
                    SingleQuotedStringEscapedChar::SingleQuote,
                ));
            } else {
                buf.push(ch);
            }
        }
        if !buf.is_empty() {
            parts.push(SingleQuotedStringPart::String(buf));
        }
        return Yaml::SingleQuotedString(parts);
    }
    // Double-quoted with EscapedChar nodes for newlines (and " and \ within).
    // pretty() converts EscapedChar-containing strings to LiteralString blocks.
    let mut parts: Vec<DoubleQuotedStringPart> = Vec::new();
    let mut buf = String::new();
    for ch in s.chars() {
        match ch {
            '\n' => {
                if !buf.is_empty() {
                    parts.push(DoubleQuotedStringPart::String(std::mem::take(&mut buf)));
                }
                parts.push(DoubleQuotedStringPart::EscapedChar(
                    DoubleQuotedStringEscapedChar::Newline,
                ));
            }
            '\r' => {
                if !buf.is_empty() {
                    parts.push(DoubleQuotedStringPart::String(std::mem::take(&mut buf)));
                }
                parts.push(DoubleQuotedStringPart::EscapedChar(
                    DoubleQuotedStringEscapedChar::CarriageReturn,
                ));
            }
            '"' => {
                if !buf.is_empty() {
                    parts.push(DoubleQuotedStringPart::String(std::mem::take(&mut buf)));
                }
                parts.push(DoubleQuotedStringPart::EscapedChar(
                    DoubleQuotedStringEscapedChar::Quote,
                ));
            }
            '\\' => {
                if !buf.is_empty() {
                    parts.push(DoubleQuotedStringPart::String(std::mem::take(&mut buf)));
                }
                parts.push(DoubleQuotedStringPart::EscapedChar(
                    DoubleQuotedStringEscapedChar::Backslash,
                ));
            }
            c => buf.push(c),
        }
    }
    if !buf.is_empty() {
        parts.push(DoubleQuotedStringPart::String(buf));
    }
    Yaml::DoubleQuotedString(parts)
}

fn yaml_to_key_string(yaml: Yaml) -> Result<String, YamlSerializeError> {
    use super::string::parse_double_quoted_string;
    match yaml {
        Yaml::UnquotedString(s) => Ok(s),
        Yaml::DoubleQuotedString(ref parts) => Ok(parse_double_quoted_string(parts)),
        _ => Err(YamlSerializeError("non-string map key".to_string())),
    }
}

// ─── Main Serializer ─────────────────────────────────────────────────────────

pub struct YamlSerializer;

impl YamlSerializer {
    pub fn new() -> Self {
        Self
    }
}

impl ser::Serializer for YamlSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;
    type SerializeSeq = SeqSerializer;
    type SerializeTuple = TupleSerializer;
    type SerializeTupleStruct = TupleSerializer;
    type SerializeTupleVariant = TupleSerializer;
    type SerializeMap = MapSerializer;
    type SerializeStruct = MapSerializer;
    type SerializeStructVariant = MapSerializer;

    fn serialize_bool(self, v: bool) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(
            if v { "true" } else { "false" }.to_string(),
        ))
    }
    fn serialize_i8(self, v: i8) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_i16(self, v: i16) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_i32(self, v: i32) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_i64(self, v: i64) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_i128(self, v: i128) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_u8(self, v: u8) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_u16(self, v: u16) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_u32(self, v: u32) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_u64(self, v: u64) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_u128(self, v: u128) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_f32(self, v: f32) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_f64(self, v: f64) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString(v.to_string()))
    }
    fn serialize_char(self, v: char) -> Result<Yaml, Self::Error> {
        Ok(str_to_yaml(&v.to_string()))
    }
    fn serialize_str(self, v: &str) -> Result<Yaml, Self::Error> {
        Ok(str_to_yaml(v))
    }
    fn serialize_bytes(self, v: &[u8]) -> Result<Yaml, Self::Error> {
        Ok(Yaml::Array(
            v.iter()
                .map(|b| ArrayData::Element(aliased(Yaml::UnquotedString(b.to_string()))))
                .collect(),
        ))
    }
    fn serialize_none(self) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString("~".to_string()))
    }
    fn serialize_some<T: Serialize + ?Sized>(self, value: &T) -> Result<Yaml, Self::Error> {
        value.serialize(Self)
    }
    fn serialize_unit(self) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString("~".to_string()))
    }
    fn serialize_unit_struct(self, _name: &'static str) -> Result<Yaml, Self::Error> {
        Ok(Yaml::UnquotedString("~".to_string()))
    }
    fn serialize_unit_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        variant: &'static str,
    ) -> Result<Yaml, Self::Error> {
        Ok(str_to_yaml(variant))
    }
    fn serialize_newtype_struct<T: Serialize + ?Sized>(
        self,
        _name: &'static str,
        value: &T,
    ) -> Result<Yaml, Self::Error> {
        value.serialize(self)
    }
    fn serialize_newtype_variant<T: Serialize + ?Sized>(
        self,
        _name: &'static str,
        _variant_index: u32,
        _variant: &'static str,
        value: &T,
    ) -> Result<Yaml, Self::Error> {
        value.serialize(self)
    }
    fn serialize_seq(self, _len: Option<usize>) -> Result<SeqSerializer, Self::Error> {
        Ok(SeqSerializer {
            elements: Vec::new(),
        })
    }
    fn serialize_tuple(self, _len: usize) -> Result<TupleSerializer, Self::Error> {
        Ok(TupleSerializer {
            elements: Vec::new(),
        })
    }
    fn serialize_tuple_struct(
        self,
        _name: &'static str,
        len: usize,
    ) -> Result<TupleSerializer, Self::Error> {
        self.serialize_tuple(len)
    }
    fn serialize_tuple_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        _variant: &'static str,
        len: usize,
    ) -> Result<TupleSerializer, Self::Error> {
        self.serialize_tuple(len)
    }
    fn serialize_map(self, _len: Option<usize>) -> Result<MapSerializer, Self::Error> {
        Ok(MapSerializer {
            entries: Vec::new(),
            current_key: None,
        })
    }
    fn serialize_struct(
        self,
        _name: &'static str,
        len: usize,
    ) -> Result<MapSerializer, Self::Error> {
        self.serialize_map(Some(len))
    }
    fn serialize_struct_variant(
        self,
        _name: &'static str,
        _variant_index: u32,
        _variant: &'static str,
        len: usize,
    ) -> Result<MapSerializer, Self::Error> {
        self.serialize_map(Some(len))
    }
}

// ─── Sequence Serializer ─────────────────────────────────────────────────────

// Sequences produce a block Array. pretty() will auto-inline them if all
// elements turn out to be simple scalars that fit on one line.
pub struct SeqSerializer {
    elements: Vec<Yaml>,
}

impl ser::SerializeSeq for SeqSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;

    fn serialize_element<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Self::Error> {
        self.elements.push(value.serialize(YamlSerializer)?);
        Ok(())
    }

    fn end(self) -> Result<Yaml, Self::Error> {
        Ok(Yaml::Array(
            self.elements
                .into_iter()
                .map(|y| ArrayData::Element(aliased(y)))
                .collect(),
        ))
    }
}

// ─── Tuple Serializer ────────────────────────────────────────────────────────

// Rust tuples always become InlineArray so the serde_yaml 0.8 block-indent
// bug (where [name, [single_arg], "True"] was emitted as [name, [single_arg,
// True]]) cannot occur.  pretty() will also auto-inline the child sequences
// (e.g. the argument list) when they contain only simple scalars.
pub struct TupleSerializer {
    elements: Vec<Yaml>,
}

impl ser::SerializeTuple for TupleSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;

    fn serialize_element<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Self::Error> {
        self.elements.push(value.serialize(YamlSerializer)?);
        Ok(())
    }

    fn end(self) -> Result<Yaml, Self::Error> {
        Ok(Yaml::InlineArray(self.elements))
    }
}

impl ser::SerializeTupleStruct for TupleSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;

    fn serialize_field<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Self::Error> {
        ser::SerializeTuple::serialize_element(self, value)
    }

    fn end(self) -> Result<Yaml, Self::Error> {
        ser::SerializeTuple::end(self)
    }
}

impl ser::SerializeTupleVariant for TupleSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;

    fn serialize_field<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Self::Error> {
        ser::SerializeTuple::serialize_element(self, value)
    }

    fn end(self) -> Result<Yaml, Self::Error> {
        ser::SerializeTuple::end(self)
    }
}

// ─── Map / Struct Serializer ─────────────────────────────────────────────────

pub struct MapSerializer {
    entries: Vec<(String, Yaml)>,
    current_key: Option<String>,
}

impl ser::SerializeMap for MapSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;

    fn serialize_key<T: Serialize + ?Sized>(&mut self, key: &T) -> Result<(), Self::Error> {
        let yaml = key.serialize(YamlSerializer)?;
        self.current_key = Some(yaml_to_key_string(yaml)?);
        Ok(())
    }

    fn serialize_value<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<(), Self::Error> {
        let key = self
            .current_key
            .take()
            .expect("serialize_value called without serialize_key");
        self.entries.push((key, value.serialize(YamlSerializer)?));
        Ok(())
    }

    fn end(self) -> Result<Yaml, Self::Error> {
        Ok(Yaml::Hash(
            self.entries
                .into_iter()
                .map(|(k, v)| {
                    HashData::Element(HashElement {
                        key: k,
                        value: aliased(v),
                    })
                })
                .collect(),
        ))
    }
}

impl ser::SerializeStruct for MapSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;

    fn serialize_field<T: Serialize + ?Sized>(
        &mut self,
        key: &'static str,
        value: &T,
    ) -> Result<(), Self::Error> {
        self.entries
            .push((key.to_string(), value.serialize(YamlSerializer)?));
        Ok(())
    }

    fn end(self) -> Result<Yaml, Self::Error> {
        ser::SerializeMap::end(self)
    }
}

impl ser::SerializeStructVariant for MapSerializer {
    type Ok = Yaml;
    type Error = YamlSerializeError;

    fn serialize_field<T: Serialize + ?Sized>(
        &mut self,
        key: &'static str,
        value: &T,
    ) -> Result<(), Self::Error> {
        ser::SerializeStruct::serialize_field(self, key, value)
    }

    fn end(self) -> Result<Yaml, Self::Error> {
        ser::SerializeMap::end(self)
    }
}