Struct toml::ser::ValueSerializer
source · #[non_exhaustive]pub struct ValueSerializer<'d> { /* private fields */ }
Expand description
Serialization for TOML values.
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.
Examples
use serde::Serialize;
#[derive(Serialize)]
struct Config {
database: Database,
}
#[derive(Serialize)]
struct Database {
ip: String,
port: Vec<u16>,
connection_max: u32,
enabled: bool,
}
let config = Config {
database: Database {
ip: "192.168.1.1".to_string(),
port: vec![8001, 8002, 8003],
connection_max: 5000,
enabled: false,
},
};
let mut value = String::new();
serde::Serialize::serialize(
&config,
toml::ser::ValueSerializer::new(&mut value)
).unwrap();
println!("{}", value)
Implementations§
Trait Implementations§
source§impl<'d> Serializer for ValueSerializer<'d>
impl<'d> Serializer for ValueSerializer<'d>
§type Ok = ()
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.§type SerializeSeq = SerializeValueArray<'d>
type SerializeSeq = SerializeValueArray<'d>
Type returned from
serialize_seq
for serializing the content of the
sequence.§type SerializeTuple = SerializeValueArray<'d>
type SerializeTuple = SerializeValueArray<'d>
Type returned from
serialize_tuple
for serializing the content of
the tuple.§type SerializeTupleStruct = SerializeValueArray<'d>
type SerializeTupleStruct = SerializeValueArray<'d>
Type returned from
serialize_tuple_struct
for serializing the
content of the tuple struct.§type SerializeTupleVariant = SerializeValueArray<'d>
type SerializeTupleVariant = SerializeValueArray<'d>
Type returned from
serialize_tuple_variant
for serializing the
content of the tuple variant.§type SerializeMap = SerializeValueTable<'d>
type SerializeMap = SerializeValueTable<'d>
Type returned from
serialize_map
for serializing the content of the
map.§type SerializeStruct = SerializeValueTable<'d>
type SerializeStruct = SerializeValueTable<'d>
Type returned from
serialize_struct
for serializing the content of
the struct.§type SerializeStructVariant = Impossible<<ValueSerializer<'d> as Serializer>::Ok, <ValueSerializer<'d> as Serializer>::Error>
type SerializeStructVariant = Impossible<<ValueSerializer<'d> as Serializer>::Ok, <ValueSerializer<'d> as Serializer>::Error>
Type returned from
serialize_struct_variant
for serializing the
content of the struct variant.source§fn serialize_bool(self, v: bool) -> Result<Self::Ok, Self::Error>
fn serialize_bool(self, v: bool) -> Result<Self::Ok, Self::Error>
Serialize a
bool
value. Read moresource§fn serialize_i8(self, v: i8) -> Result<Self::Ok, Self::Error>
fn serialize_i8(self, v: i8) -> Result<Self::Ok, Self::Error>
Serialize an
i8
value. Read moresource§fn serialize_i16(self, v: i16) -> Result<Self::Ok, Self::Error>
fn serialize_i16(self, v: i16) -> Result<Self::Ok, Self::Error>
Serialize an
i16
value. Read moresource§fn serialize_i32(self, v: i32) -> Result<Self::Ok, Self::Error>
fn serialize_i32(self, v: i32) -> Result<Self::Ok, Self::Error>
Serialize an
i32
value. Read moresource§fn serialize_i64(self, v: i64) -> Result<Self::Ok, Self::Error>
fn serialize_i64(self, v: i64) -> Result<Self::Ok, Self::Error>
Serialize an
i64
value. Read moresource§fn serialize_u16(self, v: u16) -> Result<Self::Ok, Self::Error>
fn serialize_u16(self, v: u16) -> Result<Self::Ok, Self::Error>
Serialize a
u16
value. Read moresource§fn serialize_u32(self, v: u32) -> Result<Self::Ok, Self::Error>
fn serialize_u32(self, v: u32) -> Result<Self::Ok, Self::Error>
Serialize a
u32
value. Read moresource§fn serialize_u64(self, v: u64) -> Result<Self::Ok, Self::Error>
fn serialize_u64(self, v: u64) -> Result<Self::Ok, Self::Error>
Serialize a
u64
value. Read moresource§fn serialize_f32(self, v: f32) -> Result<Self::Ok, Self::Error>
fn serialize_f32(self, v: f32) -> Result<Self::Ok, Self::Error>
Serialize an
f32
value. Read moresource§fn serialize_f64(self, v: f64) -> Result<Self::Ok, Self::Error>
fn serialize_f64(self, v: f64) -> Result<Self::Ok, Self::Error>
Serialize an
f64
value. Read moresource§fn serialize_char(self, v: char) -> Result<Self::Ok, Self::Error>
fn serialize_char(self, v: char) -> Result<Self::Ok, Self::Error>
Serialize a character. Read more
source§fn serialize_bytes(self, v: &[u8]) -> Result<Self::Ok, Self::Error>
fn serialize_bytes(self, v: &[u8]) -> Result<Self::Ok, Self::Error>
Serialize a chunk of raw byte data. Read more
source§fn serialize_some<T>(self, v: &T) -> Result<Self::Ok, Self::Error>where
T: Serialize + ?Sized,
fn serialize_some<T>(self, v: &T) -> Result<Self::Ok, Self::Error>where T: Serialize + ?Sized,
source§fn serialize_unit_variant(
self,
name: &'static str,
variant_index: u32,
variant: &'static str
) -> Result<Self::Ok, Self::Error>
fn serialize_unit_variant( self, name: &'static str, variant_index: u32, variant: &'static str ) -> Result<Self::Ok, Self::Error>
source§fn serialize_newtype_struct<T>(
self,
name: &'static str,
v: &T
) -> Result<Self::Ok, Self::Error>where
T: Serialize + ?Sized,
fn serialize_newtype_struct<T>( self, name: &'static str, v: &T ) -> Result<Self::Ok, Self::Error>where T: Serialize + ?Sized,
Serialize a newtype struct like
struct Millimeters(u8)
. Read moresource§fn serialize_newtype_variant<T>(
self,
name: &'static str,
variant_index: u32,
variant: &'static str,
value: &T
) -> Result<Self::Ok, Self::Error>where
T: Serialize + ?Sized,
fn serialize_newtype_variant<T>( self, name: &'static str, variant_index: u32, variant: &'static str, value: &T ) -> Result<Self::Ok, Self::Error>where T: Serialize + ?Sized,
source§fn serialize_seq(
self,
len: Option<usize>
) -> Result<Self::SerializeSeq, Self::Error>
fn serialize_seq( 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 moresource§fn serialize_tuple(
self,
len: usize
) -> Result<Self::SerializeTuple, Self::Error>
fn serialize_tuple( 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 moresource§fn serialize_tuple_struct(
self,
_name: &'static str,
len: usize
) -> Result<Self::SerializeTupleStruct, Self::Error>
fn serialize_tuple_struct( 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 moresource§fn serialize_tuple_variant(
self,
_name: &'static str,
_variant_index: u32,
_variant: &'static str,
len: usize
) -> Result<Self::SerializeTupleVariant, Self::Error>
fn serialize_tuple_variant( 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 moresource§fn serialize_map(
self,
len: Option<usize>
) -> Result<Self::SerializeMap, Self::Error>
fn serialize_map( 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 moresource§fn serialize_struct(
self,
_name: &'static str,
len: usize
) -> Result<Self::SerializeStruct, Self::Error>
fn serialize_struct( 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 moresource§fn serialize_struct_variant(
self,
name: &'static str,
_variant_index: u32,
_variant: &'static str,
_len: usize
) -> Result<Self::SerializeStructVariant, Self::Error>
fn serialize_struct_variant( 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 moresource§fn serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error>
fn serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error>
Serialize an
i128
value. Read moresource§fn serialize_u128(self, v: u128) -> Result<Self::Ok, Self::Error>
fn serialize_u128(self, v: u128) -> Result<Self::Ok, Self::Error>
Serialize a
u128
value. Read moresource§fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>where
I: IntoIterator,
<I as IntoIterator>::Item: Serialize,
fn collect_seq<I>(self, iter: I) -> Result<Self::Ok, Self::Error>where I: IntoIterator, <I as IntoIterator>::Item: Serialize,
Collect an iterator as a sequence. Read more
source§fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>where
K: Serialize,
V: Serialize,
I: IntoIterator<Item = (K, V)>,
fn collect_map<K, V, I>(self, iter: I) -> Result<Self::Ok, Self::Error>where K: Serialize, V: Serialize, I: IntoIterator<Item = (K, V)>,
Collect an iterator as a map. Read more
source§fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>where
T: Display + ?Sized,
fn collect_str<T>(self, value: &T) -> Result<Self::Ok, Self::Error>where T: Display + ?Sized,
Serialize a string produced by an implementation of
Display
. Read moresource§fn is_human_readable(&self) -> bool
fn is_human_readable(&self) -> bool
Determine whether
Serialize
implementations should serialize in
human-readable form. Read moreAuto Trait Implementations§
impl<'d> RefUnwindSafe for ValueSerializer<'d>
impl<'d> Send for ValueSerializer<'d>
impl<'d> Sync for ValueSerializer<'d>
impl<'d> Unpin for ValueSerializer<'d>
impl<'d> !UnwindSafe for ValueSerializer<'d>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more