Trait serde::Deserializer

pub trait Deserializer: Sized {
    type Error: Error;
    fn deserialize<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_byte_buf<V>(
        self, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_unit_struct<V>(
        self, 
        name: &'static str, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_newtype_struct<V>(
        self, 
        name: &'static str, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_seq_fixed_size<V>(
        self, 
        len: usize, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_tuple<V>(
        self, 
        len: usize, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_tuple_struct<V>(
        self, 
        name: &'static str, 
        len: usize, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_struct<V>(
        self, 
        name: &'static str, 
        fields: &'static [&'static str], 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_struct_field<V>(
        self, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_enum<V>(
        self, 
        name: &'static str, 
        variants: &'static [&'static str], 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
    fn deserialize_ignored_any<V>(
        self, 
        visitor: V
    ) -> Result<V::Value, Self::Error>
    where
        V: Visitor;
}

A data format that can deserialize any data structure supported by Serde.

The role of this trait is to define the deserialization half of the Serde data model, which is a way to categorize every Rust data type into one of 28 possible types. Each method of the Serializer trait corresponds to one of the types of the data model.

Implementations of Deserialize map themselves into this data model by passing to the Deserializer a Visitor implementation that can receive these various types.

The types that make up the Serde data model are:

• 12 primitive types:
  • bool
  • i8, i16, i32, i64
  • u8, u16, u32, u64
  • f32, f64
  • char
• string
• byte array - [u8]
• option
  • either none or some value
• unit
  • unit is the type of () in Rust
• unit_struct
  • for example struct Unit or PhantomData<T>
• unit_variant
  • the E::A and E::B in enum E { A, B }
• newtype_struct
  • for example struct Millimeters(u8)
• newtype_variant
  • the E::N in enum E { N(u8) }
• seq
  • a dynamically sized sequence of values, for example Vec<T> or HashSet<T>
• seq_fixed_size
  • a statically sized sequence of values for which the size will be known at deserialization time without looking at the serialized data, for example [u64; 10]
• tuple
  • for example (u8,) or (String, u64, Vec<T>)
• tuple_struct
  • for example struct Rgb(u8, u8, u8)
• tuple_variant
  • the E::T in enum E { T(u8, u8) }
• map
  • for example BTreeMap<K, V>
• struct
  • a key-value pairing in which the keys will be known at deserialization time without looking at the serialized data, for example struct S { r: u8, g: u8, b: u8 }
• struct_variant
  • the E::S in enum E { S { r: u8, g: u8, b: u8 } }

The Deserializer trait supports two entry point styles which enables different kinds of deserialization.

1. The deserialize method. Self-describing data formats like JSON are able to look at the serialized data and tell what it represents. For example the JSON deserializer may see an opening curly brace ({) and know that it is seeing a map. If the data format supports Deserializer::deserialize, it will drive the Visitor using whatever type it sees in the input. JSON uses this approach when deserializing serde_json::Value which is an enum that can represent any JSON document. Without knowing what is in a JSON document, we can deserialize it to serde_json::Value by going through Deserializer::deserialize.

2. The various deserialize_* methods. Non-self-describing formats like Bincode need to be told what is in the input in order to deserialize it. The deserialize_* methods are hints to the deserializer for how to interpret the next piece of input. Non-self-describing formats are not able to deserialize something like serde_json::Value which relies on Deserializer::deserialize.

When implementing Deserialize, you should avoid relying on Deserializer::deserialize unless you need to be told by the Deserializer what type is in the input. Know that relying on Deserializer::deserialize means your data type will be able to deserialize from self-describing formats only, ruling out Bincode and many others.

Associated Types

type Error: Error

The error type that can be returned if some error occurs during deserialization.

Required Methods

fn deserialize<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Require the Deserializer to figure out how to drive the visitor based on what data type is in the input.

When implementing Deserialize, you should avoid relying on Deserializer::deserialize unless you need to be told by the Deserializer what type is in the input. Know that relying on Deserializer::deserialize means your data type will be able to deserialize from self-describing formats only, ruling out Bincode and many others.

fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a bool value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a string value and does not benefit from taking ownership of buffered data owned by the Deserializer.

If the Visitor would benefit from taking ownership of String data, indiciate this to the Deserializer by using deserialize_string instead.

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a string value and would benefit from taking ownership of buffered data owned by the Deserializer.

If the Visitor would not benefit from taking ownership of String data, indicate that to the Deserializer by using deserialize_str instead.

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a byte array and does not benefit from taking ownership of buffered data owned by the Deserializer.

If the Visitor would benefit from taking ownership of Vec<u8> data, indicate this to the Deserializer by using deserialize_byte_buf instead.

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a byte array and would benefit from taking ownership of buffered data owned by the Deserializer.

If the Visitor would not benefit from taking ownership of Vec<u8> data, indicate that to the Deserializer by using deserialize_bytes instead.

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting an optional value.

This allows deserializers that encode an optional value as a nullable value to convert the null value into None and a regular value into Some(value).

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a unit value.

fn deserialize_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a unit struct with a particular name.

fn deserialize_newtype_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a newtype struct with a particular name.

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a sequence of values.

fn deserialize_seq_fixed_size<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a sequence of values and knows how many values there are without looking at the serialized data.

fn deserialize_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a tuple value with a particular number of elements.

fn deserialize_tuple_struct<V>(
    self,
    name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a tuple struct with a particular name and number of fields.

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a map of key-value pairs.

fn deserialize_struct<V>(
    self,
    name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting a struct with a particular name and fields.

fn deserialize_struct_field<V>(
    self,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting the name of a struct field.

fn deserialize_enum<V>(
    self,
    name: &'static str,
    variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type is expecting an enum value with a particular name and possible variants.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor, 

Hint that the Deserialize type needs to deserialize a value whose type doesn't matter because it is ignored.

Deserializers for non-self-describing formats may not support this mode.

Implementors

• impl<E> Deserializer for UnitDeserializer<E> where
    E: Error, 
• impl<E> Deserializer for BoolDeserializer<E> where
    E: Error, 
• impl<E> Deserializer for I8Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for I16Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for I32Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for I64Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for IsizeDeserializer<E> where
    E: Error, 
• impl<E> Deserializer for U8Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for U16Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for U64Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for UsizeDeserializer<E> where
    E: Error, 
• impl<E> Deserializer for F32Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for F64Deserializer<E> where
    E: Error, 
• impl<E> Deserializer for CharDeserializer<E> where
    E: Error, 
• impl<E> Deserializer for U32Deserializer<E> where
    E: Error, 
• impl<'a, E> Deserializer for StrDeserializer<'a, E> where
    E: Error, 
• impl<E> Deserializer for StringDeserializer<E> where
    E: Error, 
• impl<'a, E> Deserializer for CowStrDeserializer<'a, E> where
    E: Error, 
• impl<I, T, E> Deserializer for SeqDeserializer<I, E> where
    I: Iterator<Item = T>,
    T: ValueDeserializer<E>,
    E: Error, 
• impl<V_, E> Deserializer for SeqVisitorDeserializer<V_, E> where
    V_: SeqVisitor<Error = E>,
    E: Error, 
• impl<I, E> Deserializer for MapDeserializer<I, E> where
    I: Iterator,
    I::Item: Pair,
    <I::Item as Pair>::First: ValueDeserializer<E>,
    <I::Item as Pair>::Second: ValueDeserializer<E>,
    E: Error, 
• impl<V_, E> Deserializer for MapVisitorDeserializer<V_, E> where
    V_: MapVisitor<Error = E>,
    E: Error, 
• impl<'a, E> Deserializer for BytesDeserializer<'a, E> where
    E: Error, 
• impl<E> Deserializer for ByteBufDeserializer<E> where
    E: Error,