Struct fixed_width::Deserializer

pub struct Deserializer<'r> { /* fields omitted */ }

A deserialized for fixed width data. Reads from the given bytes using the provided field definitions to determine how many bytes to read for each deserialized value.

Methods

impl<'r, 'de> Deserializer<'r>

pub fn new(input: &'r [u8], fields: Vec<Field>) -> Self

Creates a new Deserializer from the given bytes and field definitions.

Example

extern crate serde;
extern crate fixed_width;

use fixed_width::{Deserializer, Field};
use serde::Deserialize;
use std::collections::HashMap;

fn main() {
    let input = b"1234abcd99";
    let fields = vec![
        Field::default().range(0..4).name(Some("numbers")),
        Field::default().range(4..8).name(Some("letters")),
        Field::default().range(8..10),
    ];

    let mut de = Deserializer::new(input, fields);
    let h: HashMap<String, String> = HashMap::deserialize(&mut de).unwrap();

    assert_eq!(h.get("numbers").unwrap(), "1234");
    assert_eq!(h.get("letters").unwrap(), "abcd");
    // If no name is supplied, the byte range is used as the key instead.
    assert_eq!(h.get("8..10").unwrap(), "99");
}

pub fn get_ref(&self) -> &[u8]

Gets a reference to the underlying input bytes.

Example

use fixed_width::{Deserializer, Field, Reader};

let fields = vec![Field::default().range(0..3)];
let de = Deserializer::new(b"foobar", fields);

assert_eq!(de.get_ref(), b"foobar");

Trait Implementations

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

type Error = DeserializeError

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

fn next_element_seed<S: DeserializeSeed<'de>>(
    &mut self,
    seed: S
) -> Result<Option<S::Value>, Self::Error>

This returns Ok(Some(value)) for the next value in the sequence, or Ok(None) if there are no more remaining items.

fn next_element<T>(&mut self) -> Result<Option<T>, Self::Error> where
    T: Deserialize<'de>, 

This returns Ok(Some(value)) for the next value in the sequence, or Ok(None) if there are no more remaining items.

fn size_hint(&self) -> Option<usize>

Returns the number of elements remaining in the sequence, if known.

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

type Error = DeserializeError

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

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

Hint that the Deserialize type is expecting a bool value.

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

Hint that the Deserialize type is expecting an i8 value.

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

Hint that the Deserialize type is expecting an i16 value.

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

Hint that the Deserialize type is expecting an i32 value.

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

Hint that the Deserialize type is expecting an i64 value.

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

Hint that the Deserialize type is expecting a u8 value.

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

Hint that the Deserialize type is expecting a u16 value.

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

Hint that the Deserialize type is expecting a u32 value.

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

Hint that the Deserialize type is expecting a u64 value.

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

Hint that the Deserialize type is expecting a f32 value.

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

Hint that the Deserialize type is expecting a f64 value.

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

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

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

Hint that the Deserialize type is expecting a char value.

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

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

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

Hint that the Deserialize type is expecting an optional value.

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

Hint that the Deserialize type is expecting a unit value.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

type Error = DeserializeError

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

fn next_key_seed<S: DeserializeSeed<'de>>(
    &mut self,
    seed: S
) -> Result<Option<S::Value>, Self::Error>

This returns Ok(Some(key)) for the next key in the map, or Ok(None) if there are no more remaining entries.

fn next_value_seed<S: DeserializeSeed<'de>>(
    &mut self,
    seed: S
) -> Result<S::Value, Self::Error>

This returns a Ok(value) for the next value in the map.

fn next_entry_seed<K, V>(
    &mut self,
    kseed: K,
    vseed: V
) -> Result<Option<(<K as DeserializeSeed<'de>>::Value, <V as DeserializeSeed<'de>>::Value)>, Self::Error> where
    K: DeserializeSeed<'de>,
    V: DeserializeSeed<'de>, 

This returns Ok(Some((key, value))) for the next (key-value) pair in the map, or Ok(None) if there are no more remaining items.

fn next_key<K>(&mut self) -> Result<Option<K>, Self::Error> where
    K: Deserialize<'de>, 

This returns Ok(Some(key)) for the next key in the map, or Ok(None) if there are no more remaining entries.

fn next_value<V>(&mut self) -> Result<V, Self::Error> where
    V: Deserialize<'de>, 

This returns a Ok(value) for the next value in the map.

fn next_entry<K, V>(&mut self) -> Result<Option<(K, V)>, Self::Error> where
    K: Deserialize<'de>,
    V: Deserialize<'de>, 

This returns Ok(Some((key, value))) for the next (key-value) pair in the map, or Ok(None) if there are no more remaining items.

fn size_hint(&self) -> Option<usize>

Returns the number of entries remaining in the map, if known.

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

type Error = DeserializeError

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

type Variant = Self

The Visitor that will be used to deserialize the content of the enum variant.

fn variant_seed<S: DeserializeSeed<'de>>(
    self,
    seed: S
) -> Result<(S::Value, Self::Variant), Self::Error>

variant is called to identify which variant to deserialize.

fn variant<V>(self) -> Result<(V, Self::Variant), Self::Error> where
    V: Deserialize<'de>, 

variant is called to identify which variant to deserialize.

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

type Error = DeserializeError

The error type that can be returned if some error occurs during deserialization. Must match the error type of our EnumAccess.

fn unit_variant(self) -> Result<(), Self::Error>

Called when deserializing a variant with no values.

fn newtype_variant_seed<T: DeserializeSeed<'de>>(
    self,
    _seed: T
) -> Result<T::Value, Self::Error>

Called when deserializing a variant with a single value.

fn tuple_variant<V: Visitor<'de>>(
    self,
    _len: usize,
    _visitor: V
) -> Result<V::Value, Self::Error>

Called when deserializing a tuple-like variant.

fn struct_variant<V: Visitor<'de>>(
    self,
    _fields: &'static [&'static str],
    _visitor: V
) -> Result<V::Value, Self::Error>

Called when deserializing a struct-like variant.

fn newtype_variant<T>(self) -> Result<T, Self::Error> where
    T: Deserialize<'de>, 

Called when deserializing a variant with a single value.