      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
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178

    use std::{io, marker};
    use compact_integer::CompactInteger;

    pub fn deserialize<R, T>(buffer: R) -> Result<T, Error> where R: io::Read, T: Deserializable {
    	let mut reader = Reader::from_read(buffer);
    	let result = try!(reader.read());

    	if reader.is_finished() {
    		Ok(result)
    	} else {
    		Err(Error::UnreadData)
    	}
    }

    pub fn deserialize_iterator<R, T>(buffer: R) -> ReadIterator<R, T> where R: io::Read, T: Deserializable {
    	ReadIterator {
    		reader: Reader::from_read(buffer),
    		iter_type: marker::PhantomData,
    	}
    }

    #[derive(Debug, PartialEq)]
    pub enum Error {
    	MalformedData,
    	UnexpectedEnd,
    	UnreadData,
    }

    impl From<io::Error> for Error {
    	fn from(_: io::Error) -> Self {
    		Error::UnexpectedEnd
    	}
    }

    pub trait Deserializable {
    	fn deserialize<T>(reader: &mut Reader<T>) -> Result<Self, Error> where Self: Sized, T: io::Read;
    }

    /// Bitcoin structures reader.
    #[derive(Debug)]
    pub struct Reader<T> {
    	buffer: T,
    	peeked: Option<u8>,
    }

    impl<'a> Reader<&'a [u8]> {
    	/// Convenient way of creating for slice of bytes
    	pub fn new(buffer: &'a [u8]) -> Self {
    		Reader {
    			buffer: buffer,
    			peeked: None,
    		}
    	}
    }

    impl<T> io::Read for Reader<T> where T: io::Read {
    	fn read(&mut self, buf: &mut [u8]) -> Result<usize, io::Error> {
    		// most of the times, there will be nothing in peeked,
    		// so to make it as efficient as possible, check it
    		// only once
    		match self.peeked.take() {
    			None => io::Read::read(&mut self.buffer, buf),
    			Some(peeked) if buf.is_empty() => {
    				self.peeked = Some(peeked);
    				Ok(0)
    			},
    			Some(peeked) => {
    				buf[0] = peeked;
    				io::Read::read(&mut self.buffer, &mut buf[1..]).map(|x| x + 1)
    			},
    		}
    	}
    }

    impl<R> Reader<R> where R: io::Read {
    	pub fn from_read(read: R) -> Self {
    		Reader {
    			buffer: read,
    			peeked: None,
    		}
    	}

    	pub fn read<T>(&mut self) -> Result<T, Error> where T: Deserializable {
    		T::deserialize(self)
    	}

    	pub fn read_with_proxy<T, F>(&mut self, proxy: F) -> Result<T, Error> where T: Deserializable, F: FnMut(&[u8]) {
    		let mut reader = Reader::from_read(Proxy::new(self, proxy));
    		T::deserialize(&mut reader)
    	}

    	pub fn read_slice(&mut self, bytes: &mut [u8]) -> Result<(), Error> {
    		io::Read::read_exact(self, bytes).map_err(|_| Error::UnexpectedEnd)
    	}

    	pub fn read_list<T>(&mut self) -> Result<Vec<T>, Error> where T: Deserializable {
    		let len: usize = try!(self.read::<CompactInteger>()).into();
    		let mut result = Vec::with_capacity(len);

    		for _ in 0..len {
    			result.push(try!(self.read()));
    		}

    		Ok(result)
    	}

    	pub fn read_list_max<T>(&mut self, max: usize) -> Result<Vec<T>, Error> where T: Deserializable {
    		let len: usize = try!(self.read::<CompactInteger>()).into();
    		if len > max {
    			return Err(Error::MalformedData);
    		}

    		let mut result = Vec::with_capacity(len);

    		for _ in 0..len {
    			result.push(try!(self.read()));
    		}

    		Ok(result)
    	}

    	#[cfg_attr(feature="cargo-clippy", allow(wrong_self_convention))]
    	pub fn is_finished(&mut self) -> bool {
    		if self.peeked.is_some() {
    			return false;
    		}

    		let peek: &mut [u8] = &mut [0u8];
    		match self.read_slice(peek) {
    			Ok(_) => {
    				self.peeked = Some(peek[0]);
    				false
    			},
    			Err(_) => true,
    		}
    	}
    }

    /// Should be used to iterate over structures of the same type
    pub struct ReadIterator<R, T> {
    	reader: Reader<R>,
    	iter_type: marker::PhantomData<T>,
    }

    impl<R, T> Iterator for ReadIterator<R, T> where R: io::Read, T: Deserializable {
    	type Item = Result<T, Error>;

    	fn next(&mut self) -> Option<Self::Item> {
    		if self.reader.is_finished() {
    			None
    		} else {
    			Some(self.reader.read())
    		}
    	}
    }

    struct Proxy<F, T> {
    	from: F,
    	to: T,
    }

    impl<F, T> Proxy<F, T> {
    	fn new(from: F, to: T) -> Self {
    		Proxy {
    			from: from,
    			to: to,
    		}
    	}
    }

    impl<F, T> io::Read for Proxy<F, T> where F: io::Read, T: FnMut(&[u8]) {
    	fn read(&mut self, buf: &mut [u8]) -> Result<usize, io::Error> {
    		let len = try!(io::Read::read(&mut self.from, buf));
    		let to = &mut self.to;
    		to(&buf[..len]);
    		Ok(len)
    	}
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)