      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

    //! Stream used for serialization of Bitcoin structures
    use std::io::{self, Write};
    use std::borrow::Borrow;
    use compact_integer::CompactInteger;
    use bytes::Bytes;

    /// Do not serialize transaction witness data.
    pub const SERIALIZE_TRANSACTION_WITNESS: u32 = 0x40000000;

    pub fn serialize<T>(t: &T) -> Bytes where T: Serializable{
    	let mut stream = Stream::default();
    	stream.append(t);
    	stream.out()
    }

    pub fn serialize_with_flags<T>(t: &T, flags: u32) -> Bytes where T: Serializable{
    	let mut stream = Stream::with_flags(flags);
    	stream.append(t);
    	stream.out()
    }

    pub fn serialize_list<T, K>(t: &[K]) -> Bytes where T: Serializable, K: Borrow<T> {
    	let mut stream = Stream::default();
    	stream.append_list(t);
    	stream.out()
    }

    pub fn serialized_list_size<T, K>(t: &[K]) -> usize where T: Serializable, K: Borrow<T> {
    	CompactInteger::from(t.len()).serialized_size() +
    		t.iter().map(Borrow::borrow).map(Serializable::serialized_size).sum::<usize>()
    }

    pub fn serialized_list_size_with_flags<T, K>(t: &[K], flags: u32) -> usize where T: Serializable, K: Borrow<T> {
    	CompactInteger::from(t.len()).serialized_size() +
    		t.iter().map(Borrow::borrow).map(|i| Serializable::serialized_size_with_flags(i, flags)).sum::<usize>()
    }

    pub trait Serializable {
    	/// Serialize the struct and appends it to the end of stream.
    	fn serialize(&self, s: &mut Stream);

    	/// Hint about the size of serialized struct.
    	fn serialized_size(&self) -> usize where Self: Sized {
    		// fallback implementation
    		serialize(self).len()
    	}

    	/// Hint about the size of serialized struct with given flags.
    	fn serialized_size_with_flags(&self, flags: u32) -> usize where Self: Sized {
    		// fallback implementation
    		serialize_with_flags(self, flags).len()
    	}
    }

    /// Stream used for serialization of Bitcoin structures
    #[derive(Default)]
    pub struct Stream {
    	buffer: Vec<u8>,
    	flags: u32,
    }

    impl Stream {
    	/// New stream
    	pub fn new() -> Self {
    		Stream { buffer: Vec::new(), flags: 0 }
    	}

    	/// Create stream with given flags,
    	pub fn with_flags(flags: u32) -> Self {
    		Stream { buffer: Vec::new(), flags: flags }
    	}

    	/// Are transactions written to this stream with witness data?
    	pub fn include_transaction_witness(&self) -> bool {
    		(self.flags & SERIALIZE_TRANSACTION_WITNESS) != 0
    	}

    	/// Serializes the struct and appends it to the end of stream.
    	pub fn append<T>(&mut self, t: &T) -> &mut Self where T: Serializable {
    		t.serialize(self);
    		self
    	}

    	/// Appends raw bytes to the end of the stream.
    	pub fn append_slice(&mut self, bytes: &[u8]) -> &mut Self {
    		// discard error for now, since we write to simple vector
    		self.buffer.write(bytes).unwrap();
    		self
    	}

    	/// Appends a list of serializable structs to the end of the stream.
    	pub fn append_list<T, K>(&mut self, t: &[K]) -> &mut Self where T: Serializable, K: Borrow<T> {
    		CompactInteger::from(t.len()).serialize(self);
    		for i in t {
    			i.borrow().serialize(self);
    		}
    		self
    	}

    	/// Full stream.
    	pub fn out(self) -> Bytes {
    		self.buffer.into()
    	}
    }

    impl Write for Stream {
    	#[inline]
    	fn write(&mut self, buf: &[u8]) -> Result<usize, io::Error> {
    		self.buffer.write(buf)
    	}

    	#[inline]
    	fn flush(&mut self) -> Result<(), io::Error> {
    		self.buffer.flush()
    	}
    }

# 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`)