pub trait Serialize {
// Required method
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer;
}
Expand description
A data structure that can be serialized into any data format supported by Serde.
Serde provides Serialize
implementations for many Rust primitive and
standard library types. The complete list is here. All of
these can be serialized using Serde out of the box.
Additionally, Serde provides a procedural macro called serde_derive
to
automatically generate Serialize
implementations for structs and enums in
your program. See the derive section of the manual for how to use this.
In rare cases it may be necessary to implement Serialize
manually for some
type in your program. See the Implementing Serialize
section of the
manual for more about this.
Third-party crates may provide Serialize
implementations for types that
they expose. For example the linked-hash-map
crate provides a
LinkedHashMap<K, V>
type that is serializable by Serde because the crate
provides an implementation of Serialize
for it.
Required Methods§
sourcefn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,
Serialize this value into the given Serde serializer.
See the Implementing Serialize
section of the manual for more
information about how to implement this method.
use serde::ser::{Serialize, SerializeStruct, Serializer};
struct Person {
name: String,
age: u8,
phones: Vec<String>,
}
// This is what #[derive(Serialize)] would generate.
impl Serialize for Person {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: Serializer,
{
let mut s = serializer.serialize_struct("Person", 3)?;
s.serialize_field("name", &self.name)?;
s.serialize_field("age", &self.age)?;
s.serialize_field("phones", &self.phones)?;
s.end()
}
}
Object Safety§
Implementations on Foreign Types§
source§impl Serialize for SocketAddr
Available on crate feature std
only.
impl Serialize for SocketAddr
std
only.source§impl Serialize for SocketAddrV4
Available on crate feature std
only.
impl Serialize for SocketAddrV4
std
only.source§impl Serialize for SocketAddrV6
Available on crate feature std
only.
impl Serialize for SocketAddrV6
std
only.source§impl Serialize for AtomicBool
Available on crate feature std
and target_has_atomic="8"
only.
impl Serialize for AtomicBool
std
and target_has_atomic="8"
only.source§impl Serialize for AtomicIsize
Available on crate feature std
and target_has_atomic="ptr"
only.
impl Serialize for AtomicIsize
std
and target_has_atomic="ptr"
only.source§impl Serialize for AtomicUsize
Available on crate feature std
and target_has_atomic="ptr"
only.
impl Serialize for AtomicUsize
std
and target_has_atomic="ptr"
only.source§impl Serialize for SystemTime
Available on crate feature std
only.
impl Serialize for SystemTime
std
only.source§impl Serialize for NonZeroI16
impl Serialize for NonZeroI16
source§impl Serialize for NonZeroI32
impl Serialize for NonZeroI32
source§impl Serialize for NonZeroI64
impl Serialize for NonZeroI64
source§impl Serialize for NonZeroI128
impl Serialize for NonZeroI128
source§impl Serialize for NonZeroIsize
impl Serialize for NonZeroIsize
source§impl Serialize for NonZeroU16
impl Serialize for NonZeroU16
source§impl Serialize for NonZeroU32
impl Serialize for NonZeroU32
source§impl Serialize for NonZeroU64
impl Serialize for NonZeroU64
source§impl Serialize for NonZeroU128
impl Serialize for NonZeroU128
source§impl Serialize for NonZeroUsize
impl Serialize for NonZeroUsize
source§impl<Idx> Serialize for RangeInclusive<Idx>where
Idx: Serialize,
impl<Idx> Serialize for RangeInclusive<Idx>where
Idx: Serialize,
source§impl<T> Serialize for (T₁, T₂, …, Tₙ)where
T: Serialize,
impl<T> Serialize for (T₁, T₂, …, Tₙ)where
T: Serialize,
This trait is implemented for tuples up to 16 items long.
source§impl<T> Serialize for BinaryHeap<T>where
T: Serialize,
Available on crate features std
or alloc
only.
impl<T> Serialize for BinaryHeap<T>where
T: Serialize,
std
or alloc
only.source§impl<T> Serialize for BTreeSet<T>where
T: Serialize,
Available on crate features std
or alloc
only.
impl<T> Serialize for BTreeSet<T>where
T: Serialize,
std
or alloc
only.source§impl<T> Serialize for LinkedList<T>where
T: Serialize,
Available on crate features std
or alloc
only.
impl<T> Serialize for LinkedList<T>where
T: Serialize,
std
or alloc
only.source§impl<T> Serialize for VecDeque<T>where
T: Serialize,
Available on crate features std
or alloc
only.
impl<T> Serialize for VecDeque<T>where
T: Serialize,
std
or alloc
only.source§impl<T> Serialize for Rc<T>
Available on crate feature rc
and (crate features std
or alloc
) only.
impl<T> Serialize for Rc<T>
rc
and (crate features std
or alloc
) only.This impl requires the "rc"
Cargo feature of Serde.
Serializing a data structure containing Rc
will serialize a copy of
the contents of the Rc
each time the Rc
is referenced within the
data structure. Serialization will not attempt to deduplicate these
repeated data.
source§impl<T> Serialize for RcWeak<T>
Available on crate feature rc
and (crate features std
or alloc
) only.
impl<T> Serialize for RcWeak<T>
rc
and (crate features std
or alloc
) only.This impl requires the "rc"
Cargo feature of Serde.
source§impl<T> Serialize for Arc<T>
Available on crate feature rc
and (crate features std
or alloc
) only.
impl<T> Serialize for Arc<T>
rc
and (crate features std
or alloc
) only.This impl requires the "rc"
Cargo feature of Serde.
Serializing a data structure containing Arc
will serialize a copy of
the contents of the Arc
each time the Arc
is referenced within the
data structure. Serialization will not attempt to deduplicate these
repeated data.
source§impl<T> Serialize for ArcWeak<T>
Available on crate feature rc
and (crate features std
or alloc
) only.
impl<T> Serialize for ArcWeak<T>
rc
and (crate features std
or alloc
) only.This impl requires the "rc"
Cargo feature of Serde.
source§impl<T> Serialize for Vec<T>where
T: Serialize,
Available on crate features std
or alloc
only.
impl<T> Serialize for Vec<T>where
T: Serialize,
std
or alloc
only.source§impl<T> Serialize for PhantomData<T>where
T: ?Sized,
impl<T> Serialize for PhantomData<T>where
T: ?Sized,
source§impl<T> Serialize for Saturating<T>where
T: Serialize,
impl<T> Serialize for Saturating<T>where
T: Serialize,
source§impl<T, H> Serialize for HashSet<T, H>where
T: Serialize,
Available on crate feature std
only.
impl<T, H> Serialize for HashSet<T, H>where
T: Serialize,
std
only.