Struct toml::ser::Serializer

source ·
pub struct Serializer<'a> { /* private fields */ }
Expand description

Serialization implementation for TOML.

This structure implements serialization support for TOML to serialize an arbitrary type to TOML. Note that the TOML format does not support all datatypes in Rust, such as enums, tuples, and tuple structs. These types will generate an error when serialized.

Currently a serializer always writes its output to an in-memory String, which is passed in when creating the serializer itself.

Implementations§

Creates a new serializer which will emit TOML into the buffer provided.

The serializer can then be used to serialize a type after which the data will be present in dst.

Instantiate a “pretty” formatter

By default this will use:

  • pretty strings: strings with newlines will use the ''' syntax. See Serializer::pretty_string
  • pretty arrays: each item in arrays will be on a newline, have an indentation of 4 and have a trailing comma. See Serializer::pretty_array

Enable or Disable pretty strings

If enabled, literal strings will be used when possible and strings with one or more newlines will use triple quotes (i.e.: ''' or """)

Examples

Instead of:

single = "no newlines"
text = "\nfoo\nbar\n"

You will have:

single = 'no newlines'
text = '''
foo
bar
'''

Enable or Disable Literal strings for pretty strings

If enabled, literal strings will be used when possible and strings with one or more newlines will use triple quotes (i.e.: ''' or """)

If disabled, literal strings will NEVER be used and strings with one or more newlines will use """

Examples

Instead of:

single = "no newlines"
text = "\nfoo\nbar\n"

You will have:

single = "no newlines"
text = """
foo
bar
"""

Enable or Disable pretty arrays

If enabled, arrays will always have each item on their own line.

Some specific features can be controlled via other builder methods:

  • Serializer::pretty_array_indent: set the indent to a value other than 4.
  • Serializer::pretty_array_trailing_comma: enable/disable the trailing comma on the last item.
Examples

Instead of:

array = ["foo", "bar"]

You will have:

array = [
    "foo",
    "bar",
]

Set the indent for pretty arrays

See Serializer::pretty_array for more details.

Specify whether to use a trailing comma when serializing pretty arrays

See Serializer::pretty_array for more details.

Trait Implementations§

The output type produced by this Serializer during successful serialization. Most serializers that produce text or binary output should set Ok = () and serialize into an io::Write or buffer contained within the Serializer instance. Serializers that build in-memory data structures may be simplified by using Ok to propagate the data structure around. Read more
The error type when some error occurs during serialization.
Type returned from serialize_seq for serializing the content of the sequence. Read more
Type returned from serialize_tuple for serializing the content of the tuple. Read more
Type returned from serialize_tuple_struct for serializing the content of the tuple struct. Read more
Type returned from serialize_tuple_variant for serializing the content of the tuple variant. Read more
Type returned from serialize_map for serializing the content of the map. Read more
Type returned from serialize_struct for serializing the content of the struct. Read more
Type returned from serialize_struct_variant for serializing the content of the struct variant. Read more
Serialize a bool value. Read more
Serialize an i8 value. Read more
Serialize an i16 value. Read more
Serialize an i32 value. Read more
Serialize an i64 value. Read more
Serialize a u8 value. Read more
Serialize a u16 value. Read more
Serialize a u32 value. Read more
Serialize a u64 value. Read more
Serialize an f32 value. Read more
Serialize an f64 value. Read more
Serialize a character. Read more
Serialize a &str. Read more
Serialize a chunk of raw byte data. Read more
Serialize a None value. Read more
Serialize a Some(T) value. Read more
Serialize a () value. Read more
Serialize a unit struct like struct Unit or PhantomData<T>. Read more
Serialize a unit variant like E::A in enum E { A, B }. Read more
Serialize a newtype struct like struct Millimeters(u8). Read more
Serialize a newtype variant like E::N in enum E { N(u8) }. Read more
Begin to serialize a variably sized sequence. This call must be followed by zero or more calls to serialize_element, then a call to end. Read more
Begin to serialize a statically sized sequence whose length will be known at deserialization time without looking at the serialized data. This call must be followed by zero or more calls to serialize_element, then a call to end. Read more
Begin to serialize a tuple struct like struct Rgb(u8, u8, u8). This call must be followed by zero or more calls to serialize_field, then a call to end. Read more
Begin to serialize a tuple variant like E::T in enum E { T(u8, u8) }. This call must be followed by zero or more calls to serialize_field, then a call to end. Read more
Begin to serialize a map. This call must be followed by zero or more calls to serialize_key and serialize_value, then a call to end. Read more
Begin to serialize a struct like struct Rgb { r: u8, g: u8, b: u8 }. This call must be followed by zero or more calls to serialize_field, then a call to end. Read more
Begin to serialize a struct variant like E::S in enum E { S { r: u8, g: u8, b: u8 } }. This call must be followed by zero or more calls to serialize_field, then a call to end. Read more
Serialize an i128 value. Read more
Serialize a u128 value. Read more
Collect an iterator as a sequence. Read more
Collect an iterator as a map. Read more
Serialize a string produced by an implementation of Display. Read more
Determine whether Serialize implementations should serialize in human-readable form. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.