Trait rustc_serialize::Decodable

pub trait Decodable: Sized {
    fn decode<D: Decoder>(d: &mut D) -> Result<Self, D::Error>;
}

Trait for deserializing a type.

This can be implemented for custom data types to allow them to be decoded with Decoder implementations. Most of Rust's built-in or standard data types (like i32 and Vec<T>) have Decodable implementations provided by this module.

Note that, in general, you should let the compiler implement this for you by using the derive(RustcDecodable) attribute.

Examples

extern crate rustc_serialize;

#[derive(RustcDecodable)]
struct Point {
    x: i32,
    y: i32,
}

This generates code equivalent to:

extern crate rustc_serialize;
use rustc_serialize::Decodable;
use rustc_serialize::Decoder;

struct Point {
    x: i32,
    y: i32,
}

impl Decodable for Point {
    fn decode<D: Decoder>(d: &mut D) -> Result<Point, D::Error> {
        d.read_struct("Point", 2, |d| {
            let x = try!(d.read_struct_field("x", 0, |d| { d.read_i32() }));
            let y = try!(d.read_struct_field("y", 1, |d| { d.read_i32() }));
            Ok(Point{ x: x, y: y })
        })
    }
}

Required Methods

fn decode<D: Decoder>(d: &mut D) -> Result<Self, D::Error>

Deserialize a value using a Decoder.

Implementations on Foreign Types

impl Decodable for usize

fn decode<D: Decoder>(d: &mut D) -> Result<usize, D::Error>

impl Decodable for u8

fn decode<D: Decoder>(d: &mut D) -> Result<u8, D::Error>

impl Decodable for u16

fn decode<D: Decoder>(d: &mut D) -> Result<u16, D::Error>

impl Decodable for u32

fn decode<D: Decoder>(d: &mut D) -> Result<u32, D::Error>

impl Decodable for u64

fn decode<D: Decoder>(d: &mut D) -> Result<u64, D::Error>

impl Decodable for isize

fn decode<D: Decoder>(d: &mut D) -> Result<isize, D::Error>

impl Decodable for i8

fn decode<D: Decoder>(d: &mut D) -> Result<i8, D::Error>

impl Decodable for i16

fn decode<D: Decoder>(d: &mut D) -> Result<i16, D::Error>

impl Decodable for i32

fn decode<D: Decoder>(d: &mut D) -> Result<i32, D::Error>

impl Decodable for i64

fn decode<D: Decoder>(d: &mut D) -> Result<i64, D::Error>

impl Decodable for String

fn decode<D: Decoder>(d: &mut D) -> Result<String, D::Error>

impl Decodable for f32

fn decode<D: Decoder>(d: &mut D) -> Result<f32, D::Error>

impl Decodable for f64

fn decode<D: Decoder>(d: &mut D) -> Result<f64, D::Error>

impl Decodable for bool

fn decode<D: Decoder>(d: &mut D) -> Result<bool, D::Error>

impl Decodable for char

fn decode<D: Decoder>(d: &mut D) -> Result<char, D::Error>

impl Decodable for ()

fn decode<D: Decoder>(d: &mut D) -> Result<(), D::Error>

impl<T: Decodable> Decodable for Box<T>

fn decode<D: Decoder>(d: &mut D) -> Result<Box<T>, D::Error>

impl<T: Decodable> Decodable for Box<[T]>

fn decode<D: Decoder>(d: &mut D) -> Result<Box<[T]>, D::Error>

impl<T: Decodable> Decodable for Rc<T>

fn decode<D: Decoder>(d: &mut D) -> Result<Rc<T>, D::Error>

impl<'a, T: ?Sized> Decodable for Cow<'a, T> where
    T: ToOwned,
    T::Owned: Decodable, 

fn decode<D: Decoder>(d: &mut D) -> Result<Cow<'static, T>, D::Error>

impl<T: Decodable> Decodable for Vec<T>

fn decode<D: Decoder>(d: &mut D) -> Result<Vec<T>, D::Error>

impl<T: Decodable> Decodable for Option<T>

fn decode<D: Decoder>(d: &mut D) -> Result<Option<T>, D::Error>

impl<T: Decodable, E: Decodable> Decodable for Result<T, E>

fn decode<D: Decoder>(d: &mut D) -> Result<Result<T, E>, D::Error>

impl<T> Decodable for PhantomData<T>

fn decode<D: Decoder>(_d: &mut D) -> Result<PhantomData<T>, D::Error>

impl<T0: Decodable, T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable, T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn decode<D: Decoder>(
    d: &mut D
) -> Result<(T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11), D::Error>

impl<T1: Decodable, T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable, T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn decode<D: Decoder>(
    d: &mut D
) -> Result<(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11), D::Error>

impl<T2: Decodable, T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable, T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn decode<D: Decoder>(
    d: &mut D
) -> Result<(T2, T3, T4, T5, T6, T7, T8, T9, T10, T11), D::Error>

impl<T3: Decodable, T4: Decodable, T5: Decodable, T6: Decodable, T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn decode<D: Decoder>(
    d: &mut D
) -> Result<(T3, T4, T5, T6, T7, T8, T9, T10, T11), D::Error>

impl<T4: Decodable, T5: Decodable, T6: Decodable, T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T4, T5, T6, T7, T8, T9, T10, T11)

fn decode<D: Decoder>(
    d: &mut D
) -> Result<(T4, T5, T6, T7, T8, T9, T10, T11), D::Error>

impl<T5: Decodable, T6: Decodable, T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T5, T6, T7, T8, T9, T10, T11)

fn decode<D: Decoder>(
    d: &mut D
) -> Result<(T5, T6, T7, T8, T9, T10, T11), D::Error>

impl<T6: Decodable, T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T6, T7, T8, T9, T10, T11)

fn decode<D: Decoder>(d: &mut D) -> Result<(T6, T7, T8, T9, T10, T11), D::Error>

impl<T7: Decodable, T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T7, T8, T9, T10, T11)

fn decode<D: Decoder>(d: &mut D) -> Result<(T7, T8, T9, T10, T11), D::Error>

impl<T8: Decodable, T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T8, T9, T10, T11)

fn decode<D: Decoder>(d: &mut D) -> Result<(T8, T9, T10, T11), D::Error>

impl<T9: Decodable, T10: Decodable, T11: Decodable> Decodable for (T9, T10, T11)

fn decode<D: Decoder>(d: &mut D) -> Result<(T9, T10, T11), D::Error>

impl<T10: Decodable, T11: Decodable> Decodable for (T10, T11)

fn decode<D: Decoder>(d: &mut D) -> Result<(T10, T11), D::Error>

impl<T11: Decodable> Decodable for (T11,)

fn decode<D: Decoder>(d: &mut D) -> Result<(T11,), D::Error>

impl<T: Decodable> Decodable for [T; 32]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 32], D::Error>

impl<T: Decodable> Decodable for [T; 31]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 31], D::Error>

impl<T: Decodable> Decodable for [T; 30]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 30], D::Error>

impl<T: Decodable> Decodable for [T; 29]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 29], D::Error>

impl<T: Decodable> Decodable for [T; 28]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 28], D::Error>

impl<T: Decodable> Decodable for [T; 27]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 27], D::Error>

impl<T: Decodable> Decodable for [T; 26]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 26], D::Error>

impl<T: Decodable> Decodable for [T; 25]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 25], D::Error>

impl<T: Decodable> Decodable for [T; 24]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 24], D::Error>

impl<T: Decodable> Decodable for [T; 23]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 23], D::Error>

impl<T: Decodable> Decodable for [T; 22]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 22], D::Error>

impl<T: Decodable> Decodable for [T; 21]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 21], D::Error>

impl<T: Decodable> Decodable for [T; 20]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 20], D::Error>

impl<T: Decodable> Decodable for [T; 19]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 19], D::Error>

impl<T: Decodable> Decodable for [T; 18]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 18], D::Error>

impl<T: Decodable> Decodable for [T; 17]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 17], D::Error>

impl<T: Decodable> Decodable for [T; 16]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 16], D::Error>

impl<T: Decodable> Decodable for [T; 15]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 15], D::Error>

impl<T: Decodable> Decodable for [T; 14]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 14], D::Error>

impl<T: Decodable> Decodable for [T; 13]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 13], D::Error>

impl<T: Decodable> Decodable for [T; 12]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 12], D::Error>

impl<T: Decodable> Decodable for [T; 11]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 11], D::Error>

impl<T: Decodable> Decodable for [T; 10]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 10], D::Error>

impl<T: Decodable> Decodable for [T; 9]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 9], D::Error>

impl<T: Decodable> Decodable for [T; 8]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 8], D::Error>

impl<T: Decodable> Decodable for [T; 7]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 7], D::Error>

impl<T: Decodable> Decodable for [T; 6]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 6], D::Error>

impl<T: Decodable> Decodable for [T; 5]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 5], D::Error>

impl<T: Decodable> Decodable for [T; 4]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 4], D::Error>

impl<T: Decodable> Decodable for [T; 3]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 3], D::Error>

impl<T: Decodable> Decodable for [T; 2]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 2], D::Error>

impl<T: Decodable> Decodable for [T; 1]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 1], D::Error>

impl<T: Decodable> Decodable for [T; 0]

fn decode<D: Decoder>(d: &mut D) -> Result<[T; 0], D::Error>

impl Decodable for PathBuf

fn decode<D: Decoder>(d: &mut D) -> Result<PathBuf, D::Error>

impl<T: Decodable + Copy> Decodable for Cell<T>

fn decode<D: Decoder>(d: &mut D) -> Result<Cell<T>, D::Error>

impl<T: Decodable> Decodable for RefCell<T>

fn decode<D: Decoder>(d: &mut D) -> Result<RefCell<T>, D::Error>

impl<T: Decodable + Send + Sync> Decodable for Arc<T>

fn decode<D: Decoder>(d: &mut D) -> Result<Arc<T>, D::Error>

impl<T: Decodable> Decodable for LinkedList<T>

fn decode<D: Decoder>(d: &mut D) -> Result<LinkedList<T>, D::Error>

impl<T: Decodable> Decodable for VecDeque<T>

fn decode<D: Decoder>(d: &mut D) -> Result<VecDeque<T>, D::Error>

impl<K: Decodable + Ord, V: Decodable> Decodable for BTreeMap<K, V>

fn decode<D: Decoder>(d: &mut D) -> Result<BTreeMap<K, V>, D::Error>

impl<T: Decodable + Ord> Decodable for BTreeSet<T>

fn decode<D: Decoder>(d: &mut D) -> Result<BTreeSet<T>, D::Error>

impl<K, V> Decodable for HashMap<K, V> where
    K: Decodable + Hash + Eq,
    V: Decodable, 

fn decode<D: Decoder>(d: &mut D) -> Result<HashMap<K, V>, D::Error>

impl<T> Decodable for HashSet<T> where
    T: Decodable + Hash + Eq, 

fn decode<D: Decoder>(d: &mut D) -> Result<HashSet<T>, D::Error>

Implementors