Struct serde_pickle::de::Deserializer

pub struct Deserializer<R: Read> { /* private fields */ }

Decodes pickle streams into values.

Implementations

impl<R: Read> Deserializer<R>

pub fn new(rdr: R, options: DeOptions) -> Deserializer<R>

Construct a new Deserializer.

pub fn reset_memo(&mut self)

Reset internal state, allowing reading multiple pickle dump calls from a single stream.

By default (value_)from_reader closes the input stream. It is possible to deserialize multiple pickle objects from a single stream by implementing a custom reader and resetting the internal state before reading the next value.

Example

Using reset_memo inside a custom deserializer to deserialize multiple objects from a single stream.

struct PickleReader<R: Read + Sized>
{
    de: Deserializer<R>,
}

impl<R: Read + Sized> PickleReader<R>
{
   fn new(reader: R) -> PickleReader<R> {
       PickleReader {
           de: Deserializer::new(reader, DeOptions::new()),
       }
   }

   pub fn read_object<'de, T: Deserialize<'de>>(&mut self) -> Result<T> {
       self.de.reset_memo();
       let value = Deserialize::deserialize(&mut self.de)?;
       Ok(value)
   }
}

let input = vec![0x80, 0x04, 0x95, 0x09, 0x00, 0x00, 0x00, 0x00,
                 0x00, 0x00, 0x00, 0x8c, 0x05, 0x48, 0x65, 0x6c,
                 0x6c, 0x6f, 0x94, 0x2e, 0x80, 0x04, 0x95, 0x0a,
                 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x8c,
                 0x06, 0x70, 0x69, 0x63, 0x6b, 0x6c, 0x65, 0x94,
                 0x2e, 0x00];
let mut reader = PickleReader::new(std::io::Cursor::new(input.as_slice()));
let string1: String = reader.read_object().unwrap();
let string2: String = reader.read_object().unwrap();
assert_eq!(&string1, "Hello");
assert_eq!(&string2, "pickle");

pub fn deserialize_value(&mut self) -> Result<Value>

Decode a Value from this pickle. This is different from going through the generic serde deserialize, since it preserves some types that are not in the serde data model, such as big integers.

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

Assert that we reached the end of the stream.

Trait Implementations

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

type Error = Error

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

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

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

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

Hint that the Deserialize type is expecting an optional value.

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

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

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

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

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

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'de>, 

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<'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, Self::Error> 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_unit<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

Hint that the Deserialize type is expecting a unit value.

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

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

fn deserialize_bytes<V>(self, visitor: V) -> Result<V::Value, Self::Error> 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, Self::Error> 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_map<V>(self, visitor: V) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

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

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

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

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

fn deserialize_identifier<V>(self, visitor: V) -> Result<V::Value, Self::Error> 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_tuple<V>(
    self,
    len: usize,
    visitor: V
) -> Result<V::Value, Self::Error> 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_ignored_any<V>(self, visitor: V) -> Result<V::Value, Self::Error> 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_unit_struct<V>(
    self,
    name: &'static str,
    visitor: V
) -> Result<V::Value, Self::Error> where
    V: Visitor<'de>, 

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

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.