[go: up one dir, main page]

toml_write 0.1.2

A low-level interface for writing out TOML
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

pub trait TomlWrite: core::fmt::Write {
    fn open_table_header(&mut self) -> core::fmt::Result {
        write!(self, "[")
    }
    fn close_table_header(&mut self) -> core::fmt::Result {
        write!(self, "]")
    }

    fn open_array_of_tables_header(&mut self) -> core::fmt::Result {
        write!(self, "[[")
    }
    fn close_array_of_tables_header(&mut self) -> core::fmt::Result {
        write!(self, "]]")
    }

    fn open_inline_table(&mut self) -> core::fmt::Result {
        write!(self, "{{")
    }
    fn close_inline_table(&mut self) -> core::fmt::Result {
        write!(self, "}}")
    }

    fn open_array(&mut self) -> core::fmt::Result {
        write!(self, "[")
    }
    fn close_array(&mut self) -> core::fmt::Result {
        write!(self, "]")
    }

    fn key_sep(&mut self) -> core::fmt::Result {
        write!(self, ".")
    }

    fn keyval_sep(&mut self) -> core::fmt::Result {
        write!(self, "=")
    }

    fn key(&mut self, value: impl crate::WriteTomlKey) -> core::fmt::Result {
        value.write_toml_key(self)
    }

    /// <div class="warning">
    ///
    /// For floats, this preserves the sign bit for [`f32::NAN`] / [`f64::NAN`] for the sake of
    /// format-preserving editing.
    /// However, in most cases the sign bit is indeterminate and outputting signed NANs can be a
    /// cause of non-repeatable behavior.
    ///
    /// For general serialization, you should discard the sign bit.  For example:
    /// ```
    /// # let mut v = f64::NAN;
    /// if v.is_nan() {
    ///     v = v.copysign(1.0);
    /// }
    /// ```
    ///
    /// </div>
    fn value(&mut self, value: impl crate::WriteTomlValue) -> core::fmt::Result {
        value.write_toml_value(self)
    }

    fn val_sep(&mut self) -> core::fmt::Result {
        write!(self, ",")
    }

    fn space(&mut self) -> core::fmt::Result {
        write!(self, " ")
    }

    fn open_comment(&mut self) -> core::fmt::Result {
        write!(self, "#")
    }

    fn newline(&mut self) -> core::fmt::Result {
        writeln!(self)
    }
}

impl<W> TomlWrite for W where W: core::fmt::Write {}