Generic data structure deserialization framework.
The two most important traits in this module are
- A type that implements
Deserializeis a data structure that can be deserialized from any data format supported by Serde, and conversely
- A type that implements
Deserializeris a data format that can deserialize any data structure supported by Serde.
The Deserialize trait
Deserialize implementations for many Rust primitive and
standard library types. The complete list is below. All of these can be
deserialized using Serde out of the box.
Additionally, Serde provides a procedural macro called
Deserialize 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
Deserialize manually for
some type in your program. See the Implementing
Deserialize section of
the manual for more about this.
Third-party crates may provide
Deserialize implementations for types
that they expose. For example the
linked-hash-map crate provides a
LinkedHashMap<K, V> type that is deserializable by Serde because the
crate provides an implementation of
Deserialize for it.
The Deserializer trait
Deserializer implementations are provided by third-party crates, for
A partial list of well-maintained formats is given on the Serde website.
Implementations of Deserialize provided by Serde
This is a slightly different set of types than what is supported for
serialization. Some types can be serialized by Serde but not deserialized.
One example is
- Primitive types:
- i8, i16, i32, i64, i128, isize
- u8, u16, u32, u64, u128, usize
- f32, f64
- Compound types:
- [T; 0] through [T; 32]
- tuples up to size 16
- Common standard library types:
- Result<T, E>
- Wrapper types:
- Cow<’a, T>
- Rc<T> (if features = [“rc”] is enabled)
- Arc<T> (if features = [“rc”] is enabled)
- Collection types:
- BTreeMap<K, V>
- HashMap<K, V, H>
- HashSet<T, H>
- Zero-copy types:
- FFI types:
- Miscellaneous standard library types:
- Net types:
Unexpectedrepresents an unexpected invocation of any one of the
DeserializeSeedis the stateful form of the
Deserializetrait. If you ever find yourself looking for a way to pass data into a
Deserializeimpl, this trait is the way to do it.
Visitoraccess to the data of an enum in the input.
Deserializeimplementations to create descriptive error messages belonging to the
Deserializeragainst which they are currently running.
Expectedrepresents an explanation of what data a
Visitorwas expecting to receive.
Deserializerfrom which other values can be deserialized.
Visitoraccess to each entry of a map in the input.
Visitoraccess to each element of a sequence in the input.
VariantAccessis a visitor that is created by the
Deserializerand passed to the
Deserializeto deserialize the content of a particular enum variant.