Struct toml::ser::Serializer
[−]
[src]
pub struct Serializer<'a> { /* fields omitted */ }
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.
Methods
impl<'a> Serializer<'a>
[src]
fn new(dst: &'a mut String) -> Serializer<'a>
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
.
Trait Implementations
impl<'a, 'b> Serializer for &'b mut Serializer<'a>
[src]
type Ok = ()
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
type Error = Error
The error type when some error occurs during serialization.
type SerializeSeq = SerializeSeq<'a, 'b>
Type returned from [serialize_seq
] for serializing the content of the sequence. Read more
type SerializeTuple = Impossible<(), Error>
Type returned from [serialize_tuple
] for serializing the content of the tuple. Read more
type SerializeTupleStruct = Impossible<(), Error>
Type returned from [serialize_tuple_struct
] for serializing the content of the tuple struct. Read more
type SerializeTupleVariant = Impossible<(), Error>
Type returned from [serialize_tuple_variant
] for serializing the content of the tuple variant. Read more
type SerializeMap = SerializeTable<'a, 'b>
Type returned from [serialize_map
] for serializing the content of the map. Read more
type SerializeStruct = SerializeTable<'a, 'b>
Type returned from [serialize_struct
] for serializing the content of the struct. Read more
type SerializeStructVariant = Impossible<(), Error>
Type returned from [serialize_struct_variant
] for serializing the content of the struct variant. Read more
fn serialize_bool(self, v: bool) -> Result<(), Self::Error>
Serialize a bool
value. Read more
fn serialize_i8(self, v: i8) -> Result<(), Self::Error>
Serialize an i8
value. Read more
fn serialize_i16(self, v: i16) -> Result<(), Self::Error>
Serialize an i16
value. Read more
fn serialize_i32(self, v: i32) -> Result<(), Self::Error>
Serialize an i32
value. Read more
fn serialize_i64(self, v: i64) -> Result<(), Self::Error>
Serialize an i64
value. Read more
fn serialize_u8(self, v: u8) -> Result<(), Self::Error>
Serialize a u8
value. Read more
fn serialize_u16(self, v: u16) -> Result<(), Self::Error>
Serialize a u16
value. Read more
fn serialize_u32(self, v: u32) -> Result<(), Self::Error>
Serialize a u32
value. Read more
fn serialize_u64(self, v: u64) -> Result<(), Self::Error>
Serialize a u64
value. Read more
fn serialize_f32(self, v: f32) -> Result<(), Self::Error>
Serialize an f32
value. Read more
fn serialize_f64(self, v: f64) -> Result<(), Self::Error>
Serialize an f64
value. Read more
fn serialize_char(self, v: char) -> Result<(), Self::Error>
Serialize a character. Read more
fn serialize_str(self, value: &str) -> Result<(), Self::Error>
Serialize a &str
. Read more
fn serialize_bytes(self, value: &[u8]) -> Result<(), Self::Error>
Serialize a chunk of raw byte data. Read more
fn serialize_none(self) -> Result<(), Self::Error>
Serialize a [None
] value. Read more
fn serialize_some<T: ?Sized>(self, value: &T) -> Result<(), Self::Error> where
T: Serialize,
T: Serialize,
Serialize a [Some(T)
] value. Read more
fn serialize_unit(self) -> Result<(), Self::Error>
Serialize a ()
value. Read more
fn serialize_unit_struct(self, _name: &'static str) -> Result<(), Self::Error>
Serialize a unit struct like struct Unit
or PhantomData<T>
. Read more
fn serialize_unit_variant(
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str
) -> Result<(), Self::Error>
self,
_name: &'static str,
_variant_index: u32,
variant: &'static str
) -> Result<(), Self::Error>
Serialize a unit variant like E::A
in enum E { A, B }
. Read more
fn serialize_newtype_struct<T: ?Sized>(
self,
_name: &'static str,
value: &T
) -> Result<(), Self::Error> where
T: Serialize,
self,
_name: &'static str,
value: &T
) -> Result<(), Self::Error> where
T: Serialize,
Serialize a newtype struct like struct Millimeters(u8)
. Read more
fn serialize_newtype_variant<T: ?Sized>(
self,
_name: &'static str,
_variant_index: u32,
_variant: &'static str,
_value: &T
) -> Result<(), Self::Error> where
T: Serialize,
self,
_name: &'static str,
_variant_index: u32,
_variant: &'static str,
_value: &T
) -> Result<(), Self::Error> where
T: Serialize,
Serialize a newtype variant like E::N
in enum E { N(u8) }
. Read more
fn serialize_seq(
self,
_len: Option<usize>
) -> Result<Self::SerializeSeq, Self::Error>
self,
_len: Option<usize>
) -> Result<Self::SerializeSeq, Self::Error>
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
fn serialize_tuple(
self,
_len: usize
) -> Result<Self::SerializeTuple, Self::Error>
self,
_len: usize
) -> Result<Self::SerializeTuple, Self::Error>
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
fn serialize_tuple_struct(
self,
_name: &'static str,
_len: usize
) -> Result<Self::SerializeTupleStruct, Self::Error>
self,
_name: &'static str,
_len: usize
) -> Result<Self::SerializeTupleStruct, Self::Error>
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
fn serialize_tuple_variant(
self,
_name: &'static str,
_variant_index: u32,
_variant: &'static str,
_len: usize
) -> Result<Self::SerializeTupleVariant, Self::Error>
self,
_name: &'static str,
_variant_index: u32,
_variant: &'static str,
_len: usize
) -> Result<Self::SerializeTupleVariant, Self::Error>
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
fn serialize_map(
self,
_len: Option<usize>
) -> Result<Self::SerializeMap, Self::Error>
self,
_len: Option<usize>
) -> Result<Self::SerializeMap, Self::Error>
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
fn serialize_struct(
self,
name: &'static str,
_len: usize
) -> Result<Self::SerializeStruct, Self::Error>
self,
name: &'static str,
_len: usize
) -> Result<Self::SerializeStruct, Self::Error>
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
fn serialize_struct_variant(
self,
_name: &'static str,
_variant_index: u32,
_variant: &'static str,
_len: usize
) -> Result<Self::SerializeStructVariant, Self::Error>
self,
_name: &'static str,
_variant_index: u32,
_variant: &'static str,
_len: usize
) -> Result<Self::SerializeStructVariant, Self::Error>
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
fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
I: IntoIterator,
<I as IntoIterator>::Item: Serialize,
I: IntoIterator,
<I as IntoIterator>::Item: Serialize,
Collect an iterator as a sequence. Read more
fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error> where
I: IntoIterator<Item = (K, V)>,
K: Serialize,
V: Serialize,
I: IntoIterator<Item = (K, V)>,
K: Serialize,
V: Serialize,
Collect an iterator as a map. Read more
fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error> where
T: Display + ?Sized,
T: Display + ?Sized,
Serialize a string produced by an implementation of Display
. Read more