[go: up one dir, main page]

speedy 0.4.1

A fast binary serialization framework
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

use std::io::{
    self,
    Read
};

use reader::Reader;
use context::Context;
use endianness::Endianness;

struct StreamReader< C: Context, S: Read > {
    context: C,
    reader: S
}

impl< 'a, C: Context, S: Read > Reader< 'a, C > for StreamReader< C, S > {
    #[inline]
    fn read_bytes( &mut self, output: &mut [u8] ) -> io::Result< () > {
        self.reader.read_exact( output )
    }

    #[inline]
    fn context( &self ) -> &C {
        &self.context
    }

    #[inline]
    fn context_mut( &mut self ) -> &mut C {
        &mut self.context
    }
}

impl< C: Context, S: Read > StreamReader< C, S > {
    #[inline]
    fn deserialize< 'a, T: Readable< 'a, C > >( context: C, reader: S ) -> io::Result< T > {
        let mut reader = StreamReader { context, reader };
        T::read_from( &mut reader )
    }
}

pub trait Readable< 'a, C: Context >: Sized {
    fn read_from< R: Reader< 'a, C > >( reader: &mut R ) -> io::Result< Self >;

    #[inline]
    fn minimum_bytes_needed() -> usize {
        0
    }

    #[inline]
    fn read_from_buffer( context: C, mut buffer: &'a [u8] ) -> io::Result< Self > {
        StreamReader::deserialize( context, &mut buffer )
    }

    #[inline]
    fn read_from_buffer_owned( context: C, mut buffer: &[u8] ) -> io::Result< Self > {
        StreamReader::deserialize( context, &mut buffer )
    }

    #[inline]
    fn read_from_stream< S: Read >( context: C, stream: S ) -> io::Result< Self > {
        StreamReader::deserialize( context, stream )
    }

    // Since specialization is not stable yet we do it this way.
    #[doc(hidden)]
    #[inline]
    fn speedy_is_primitive() -> bool {
        false
    }

    #[doc(hidden)]
    #[inline]
    unsafe fn speedy_slice_as_bytes_mut( _: &mut [Self] ) -> &mut [u8] {
        panic!();
    }

    #[doc(hidden)]
    #[inline]
    fn speedy_convert_slice_endianness( _: Endianness, _: &mut [Self] ) {
        panic!()
    }
}