Struct Deserializer 

pub struct Deserializer<'de, P> { /* private fields */ }

Serde JSON deserializer.

P must implement StringByteDecoder.

• deserializes data from a mutable slice,
• unescapes strings in-place,
• decodes strings or number arrays into bytes in-place,
• deserializes borrowed references to &str and &[u8] types,
• deserializes bytes from arrays of numbers,
• deserializes bytes from strings using P as a string decoder,
• deserializes structs from JSON objects or arrays.

Implementations

impl<'de, P> Deserializer<'de, P>

Implementation exposes some helper functions for custom StringByteDecoder implementations.

pub fn from_mut_slice(input: &'de mut [u8]) -> Self

Create a new decoder instance by providing a mutable slice from which to deserialize messages.

pub fn end(self) -> Result<()>

Consume deserializer and check if trailing characters only consist of whitespace

pub fn remaining_len(&self) -> usize

Return the remaining number of unparsed bytes in the input slice.

Returns 0 when the input cursor points either at the end or beyond the end of the input slice.

pub fn peek(&self) -> Result<u8>

Peek at the next byte code and return it on success, otherwise return Err(Error::UnexpectedEof) if there are no more unparsed bytes remaining in the input slice.

pub fn eat_some(&mut self, len: usize)

Advance the input cursor by len characters.

Note: this function only increases a cursor without any checks!

pub fn eat_whitespace(&mut self) -> Result<u8>

Advance the input cursor while discarding any JSON whitespace characters from the input slice and peek at the next non-whitespace character and return that character on success. Otherwise return Err(Error::UnexpectedEof) if there are no more unparsed characters remaining in the input slice.

pub fn input_mut(&mut self) -> Result<&mut [u8]>

Return a mutable reference to the unparsed portion of the input slice on success. Otherwise return Err(Error::UnexpectedEof).

pub fn split_input(&mut self, len: usize, skip: usize) -> &'de mut [u8]

Split the unparsed portion of the input slice between 0..len and return it with the lifetime of the original slice container.

The returned slice can be passed to visit_borrowed_* functions of a Visitor.

Drop already parsed bytes and bytes between len..len+skip and the new unparsed input slice will begin at len + skip.

Panics

Panics if len + skip overflows or is larger than the size of the unparsed input slice.

pub fn parse_unsigned<T: NumParseTool>(&mut self) -> Result<T>

Consume whitespace and then parse a number as an unsigned integer

pub fn parse_signed<T>(&mut self) -> Result<T>

where T: NumParseTool + CheckedSub + Neg<Output = T>,

Consume whitespace and then parse a number as a signed integer

pub fn parse_token_content(&mut self, token: &[u8]) -> Result<()>

Parse a token and if match is found advance the cursor.

Example tokens: b"null", b"true", b"false".

pub fn eat_str_content(&mut self) -> Result<()>

Consume a content of a string until the closing '"', ignoring all escape codes except immediately before any '"'.

Call after consuming the initial '"'.

pub fn parse_str_content(&mut self) -> Result<&'de str>

Parse a string until a closing '"' is found, return a decoded str slice.

Handles escape sequences using in-place copy, call after consuming an opening '"'

pub fn parse_str_bytes_content(&mut self) -> Result<&'de [u8]>

Parse a string until a closing '"' is found. Return decoded in-place string data on success.

Handles escape sequences using in-place copy, call after consuming an opening '"'

pub fn parse_hex_bytes_content(&mut self) -> Result<&'de [u8]>

Parse a string as pairs of hexadecimal nibbles until a closing '"' is found. Return decoded in-place binary data on success.

Call after consuming an opening '"'.

pub fn parse_base64_bytes_content(&mut self) -> Result<&'de [u8]>

Parse a string as BASE-64 encoded bytes until a closing ‘“’ is found. Return decoded in-place binary data on success.

Call after consuming an opening '"'.

Trait Implementations

impl<'de, P> Deserializer<'de> for &mut Deserializer<'de, P>

where P: StringByteDecoder<'de>,

type Error = Error

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

fn deserialize_any<V>(self, visitor: V) -> Result<V::Value>

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_bool<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a bool value.

fn deserialize_i8<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i8 value.

fn deserialize_i16<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i16 value.

fn deserialize_i32<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i32 value.

fn deserialize_i64<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i64 value.

fn deserialize_u8<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u8 value.

fn deserialize_u16<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u16 value.

fn deserialize_u32<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u32 value.

fn deserialize_u64<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a u64 value.

fn deserialize_f32<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f32 value.

fn deserialize_f64<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a f64 value.

fn deserialize_char<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a char value.

fn deserialize_str<V>(self, visitor: V) -> Result<V::Value>

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_string<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

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

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value>

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>

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_option<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an optional value.

fn deserialize_unit<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting a unit value.

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

where V: Visitor<'de>,

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>

where V: Visitor<'de>,

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

fn deserialize_seq<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

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

fn deserialize_tuple<V>(self, _len: usize, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

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_struct<V>( self, _name: &'static str, _len: usize, visitor: V, ) -> Result<V::Value>

where V: Visitor<'de>,

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>

where V: Visitor<'de>,

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>

where V: Visitor<'de>,

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

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

where V: Visitor<'de>,

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

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value>

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_ignored_any<V>(self, visitor: V) -> Result<V::Value>

where V: Visitor<'de>,

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

fn deserialize_i128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

where V: Visitor<'de>,

Hint that the Deserialize type is expecting an i128 value.

fn deserialize_u128<V>( self, visitor: V, ) -> Result<<V as Visitor<'de>>::Value, Self::Error>

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.