Trait rustc_serialize::Encodable

pub trait Encodable {
    fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>;
}

Trait for serializing a type.

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

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

Examples

extern crate rustc_serialize;

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

This generates code equivalent to:

extern crate rustc_serialize;
use rustc_serialize::Encodable;
use rustc_serialize::Encoder;

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

impl Encodable for Point {
    fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
        s.emit_struct("Point", 2, |s| {
            try!(s.emit_struct_field("x", 0, |s| {
                s.emit_i32(self.x)
            }));
            try!(s.emit_struct_field("y", 1, |s| {
                s.emit_i32(self.y)
            }));
            Ok(())
        })
    }
}

Required Methods

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

Serialize a value using an Encoder.

Implementations on Foreign Types

impl Encodable for usize

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for u8

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for u16

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for u32

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for u64

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for isize

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for i8

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for i16

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for i32

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for i64

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for str

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for String

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for f32

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for f64

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for bool

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for char

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for ()

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<'a, T: ?Sized + Encodable> Encodable for &'a T

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: ?Sized + Encodable> Encodable for Box<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for Rc<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<'a, T: Encodable + ToOwned + ?Sized> Encodable for Cow<'a, T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for [T]

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for Vec<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for Option<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T> Encodable for PhantomData<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl Encodable for Path

fn encode<S: Encoder>(&self, e: &mut S) -> Result<(), S::Error>

impl Encodable for PathBuf

fn encode<S: Encoder>(&self, e: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for RefCell<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for Arc<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for LinkedList<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

impl<T: Encodable> Encodable for VecDeque<T>

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, e: &mut S) -> Result<(), S::Error>

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

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

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

fn encode<E: Encoder>(&self, e: &mut E) -> Result<(), E::Error>

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

fn encode<E: Encoder>(&self, s: &mut E) -> Result<(), E::Error>

Implementors

impl Encodable for Json

fn encode<S: Encoder>(&self, e: &mut S) -> Result<(), S::Error>