Struct quick_xml::de::Deserializer

pub struct Deserializer<'de, R>where
    R: XmlRead<'de>,{ /* private fields */ }

An xml deserializer

Implementations

impl<'de, R> Deserializer<'de, R>where
    R: XmlRead<'de>,

pub fn new(reader: R) -> Self

Create an XML deserializer from one of the possible quick_xml input sources.

Typically it is more convenient to use one of these methods instead:

• Deserializer::from_str
• Deserializer::from_slice
• Deserializer::from_reader

pub fn from_borrowing_reader(reader: R) -> Self

👎Deprecated:

Use Deserializer::new instead

Get a new deserializer from a regular BufRead

impl<'de> Deserializer<'de, SliceReader<'de>>

pub fn from_str(s: &'de str) -> Self

Create new deserializer that will borrow data from the specified string

pub fn from_slice(bytes: &'de [u8]) -> Self

Create new deserializer that will borrow data from the specified byte array

impl<'de, R> Deserializer<'de, IoReader<R>>where
    R: BufRead,

pub fn from_reader(reader: R) -> Self

Create new deserializer that will copy data from the specified reader into internal buffer. If you already have a string or a byte array, use Self::from_str or Self::from_slice instead, because they will borrow instead of copy, whenever possible

Trait Implementations

impl<'de, 'a, R> Deserializer<'de> for &'a mut Deserializer<'de, R>where
    R: XmlRead<'de>,

fn deserialize_string<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Representation of owned strings the same as non-owned.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Unit represented in XML as a xs:element or text/CDATA content. Any content inside xs:element is ignored and skipped.

Produces unit struct from any of following inputs:

• any <tag ...>...</tag>
• any <tag .../>
• any text content
• any CDATA content

Events handling

Event	XML	Handling
DeEvent::Start	<tag>...</tag>	Calls visitor.visit_unit(), consumes all events up to corresponding End event
DeEvent::End	</tag>	Emits DeError::End
DeEvent::Text	text content	Calls visitor.visit_unit(). Text content is ignored
DeEvent::CData	<![CDATA[cdata content]]>	Calls visitor.visit_unit(). CDATA content is ignored
DeEvent::Eof		Emits DeError::Eof

fn deserialize_unit_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Representation of the names units the same as unnamed units

fn deserialize_tuple<V>(
    self,
    _len: usize,
    visitor: V
) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Representation of tuples the same as sequences.

fn deserialize_tuple_struct<V>(
    self,
    _name: &'static str,
    len: usize,
    visitor: V
) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Representation of named tuples the same as unnamed tuples.

fn deserialize_ignored_any<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Always call visitor.visit_unit() because returned value ignored in any case.

This method consumes any single event except the Start event, in which case all events up to corresponding End event will be consumed.

This method returns error if current event is End or Eof

type Error = DeError

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

fn deserialize_struct<V>(
    self,
    _name: &'static str,
    fields: &'static [&'static str],
    visitor: V
) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_byte_buf<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_newtype_struct<V>(
    self,
    _name: &'static str,
    visitor: V
) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_enum<V>(
    self,
    _name: &'static str,
    _variants: &'static [&'static str],
    visitor: V
) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_map<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_option<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting the name of a struct field or the discriminant of an enum variant.

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

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

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_i128<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>(self, visitor: V) -> Result<V::Value, DeError>where
    V: Visitor<'de>,

Hint that the Deserialize type is expecting an u128 value.

fn is_human_readable(&self) -> bool

Determine whether Deserialize implementations should expect to deserialize their human-readable form.