[][src]Struct serde_json::Deserializer

pub struct Deserializer<R> { /* fields omitted */ }

A structure that deserializes JSON into Rust values.


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

Create a JSON deserializer from one of the possible serde_json input sources.

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

  • Deserializer::from_str
  • Deserializer::from_bytes
  • Deserializer::from_reader

impl<R> Deserializer<IoRead<R>> where
    R: Read

Creates a JSON deserializer from an io::Read.

impl<'a> Deserializer<SliceRead<'a>>

Creates a JSON deserializer from a &[u8].

impl<'a> Deserializer<StrRead<'a>>

Creates a JSON deserializer from a &str.

impl<'de, R: Read<'de>> Deserializer<R>

The Deserializer::end method should be called after a value has been fully deserialized. This allows the Deserializer to validate that the input stream is at the end or that it only has trailing whitespace.

Important traits for StreamDeserializer<'de, R, T>

Turn a JSON deserializer into an iterator over values of type T.

Trait Implementations

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

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

Parses a JSON string as bytes. Note that this function does not check whether the bytes represent a valid UTF-8 string.

The relevant part of the JSON specification is Section 8.2 of RFC 7159:

When all the strings represented in a JSON text are composed entirely of Unicode characters (however escaped), then that JSON text is interoperable in the sense that all software implementations that parse it will agree on the contents of names and of string values in objects and arrays.

However, the ABNF in this specification allows member names and string values to contain bit sequences that cannot encode Unicode characters; for example, "\uDEAD" (a single unpaired UTF-16 surrogate). Instances of this have been observed, for example, when a library truncates a UTF-16 string without checking whether the truncation split a surrogate pair. The behavior of software that receives JSON texts containing such values is unpredictable; for example, implementations might return different values for the length of a string value or even suffer fatal runtime exceptions.

The behavior of serde_json is specified to fail on non-UTF-8 strings when deserializing into Rust UTF-8 string types such as String, and succeed with non-UTF-8 bytes when deserializing using this method.

Escape sequences are processed as usual, and for \uXXXX escapes it is still checked if the hex number represents a valid Unicode code point.


You can use this to parse JSON strings containing invalid UTF-8 bytes.

extern crate serde_json;
extern crate serde_bytes;

use serde_bytes::ByteBuf;

fn look_at_bytes() -> Result<(), serde_json::Error> {
    let json_data = b"\"some bytes: \xe5\x00\xe5\"";
    let bytes: ByteBuf = serde_json::from_slice(json_data)?;

    assert_eq!(b'\xe5', bytes[12]);
    assert_eq!(b'\0', bytes[13]);
    assert_eq!(b'\xe5', bytes[14]);


Backslash escape sequences like \n are still interpreted and required to be valid, and \u escape sequences are required to represent valid Unicode code points.

extern crate serde_json;
extern crate serde_bytes;

use serde_bytes::ByteBuf;

fn look_at_bytes() {
    let json_data = b"\"invalid unicode surrogate: \\uD801\"";
    let parsed: Result<ByteBuf, _> = serde_json::from_slice(json_data);


    let expected_msg = "unexpected end of hex escape at line 1 column 35";
    assert_eq!(expected_msg, parsed.unwrap_err().to_string());

Parses a null as a None, and any other values as a Some(...).

Parses a newtype struct as the underlying value.

Parses an enum as an object like {"$KEY":$VALUE}, where $VALUE is either a straight value, a [..], or a {..}.

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

Auto Trait Implementations

impl<R> Send for Deserializer<R> where
    R: Send

impl<R> Sync for Deserializer<R> where
    R: Sync

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 

impl<T> From for T

impl<T, U> TryFrom for T where
    T: From<U>, 

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized

impl<T, U> TryInto for T where
    U: TryFrom<T>, 

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

impl<T> BorrowMut for T where
    T: ?Sized