      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
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273

    // Copyright 2015-2017 Parity Technologies (UK) Ltd.
    // This file is part of Parity.

    // Parity is free software: you can redistribute it and/or modify
    // it under the terms of the GNU General Public License as published by
    // the Free Software Foundation, either version 3 of the License, or
    // (at your option) any later version.

    // Parity is distributed in the hope that it will be useful,
    // but WITHOUT ANY WARRANTY; without even the implied warranty of
    // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    // GNU General Public License for more details.

    // You should have received a copy of the GNU General Public License
    // along with Parity.  If not, see <http://www.gnu.org/licenses/>.

    //! Lazily-decoded owning views of RLP-encoded blockchain objects.
    //! These views are meant to contain _trusted_ data -- without encoding
    //! errors or inconsistencies.
    //!
    //! In general these views are useful when only a few fields of an object
    //! are relevant. In these cases it's more efficient to decode the object piecemeal.
    //! When the entirety of the object is needed, it's better to upgrade it to a fully
    //! decoded object where parts like the hash can be saved.

    use block::Block as FullBlock;
    use header::{BlockNumber, Header as FullHeader};
    use transaction::UnverifiedTransaction;
    use views;

    use util::{Address, Hashable, H256, H2048, U256};
    use rlp::{Rlp, View};

    /// Owning header view.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct Header(Vec<u8>);

    impl Header {
    	/// Create a new owning header view.
    	/// Expects the data to be an RLP-encoded header -- any other case will likely lead to
    	/// panics further down the line.
    	pub fn new(encoded: Vec<u8>) -> Self { Header(encoded) }

    	/// Upgrade this encoded view to a fully owned `Header` object.
    	pub fn decode(&self) -> FullHeader { ::rlp::decode(&self.0) }

    	/// Get a borrowed header view onto the data.
    	#[inline]
    	pub fn view(&self) -> views::HeaderView { views::HeaderView::new(&self.0) }

    	/// Get the rlp of the header.
    	#[inline]
    	pub fn rlp(&self) -> Rlp { Rlp::new(&self.0) }

    	/// Consume the view and return the raw bytes.
    	pub fn into_inner(self) -> Vec<u8> { self.0 }
    }

    // forwarders to borrowed view.
    impl Header {
    	/// Returns the header hash.
    	pub fn hash(&self) -> H256 { self.sha3() }

    	/// Returns the parent hash.
    	pub fn parent_hash(&self) -> H256 { self.view().parent_hash() }

    	/// Returns the uncles hash.
    	pub fn uncles_hash(&self) -> H256 { self.view().uncles_hash() }

    	/// Returns the author.
    	pub fn author(&self) -> Address { self.view().author() }

    	/// Returns the state root.
    	pub fn state_root(&self) -> H256 { self.view().state_root() }

    	/// Returns the transaction trie root.
    	pub fn transactions_root(&self) -> H256 { self.view().transactions_root() }

    	/// Returns the receipts trie root
    	pub fn receipts_root(&self) -> H256 { self.view().receipts_root() }

    	/// Returns the block log bloom
    	pub fn log_bloom(&self) -> H2048 { self.view().log_bloom() }

    	/// Difficulty of this block
    	pub fn difficulty(&self) -> U256 { self.view().difficulty() }

    	/// Number of this block.
    	pub fn number(&self) -> BlockNumber { self.view().number() }

    	/// Time this block was produced.
    	pub fn timestamp(&self) -> u64 { self.view().timestamp() }

    	/// Gas limit of this block.
    	pub fn gas_limit(&self) -> U256 { self.view().gas_limit() }

    	/// Total gas used in this block.
    	pub fn gas_used(&self) -> U256 { self.view().gas_used() }

    	/// Block extra data.
    	pub fn extra_data(&self) -> Vec<u8> { self.view().extra_data() }

    	/// Engine-specific seal fields.
    	pub fn seal(&self) -> Vec<Vec<u8>> { self.view().seal() }
    }

    impl Hashable for Header {
    	fn sha3(&self) -> H256 {
    		self.0.sha3()
    	}
    }

    /// Owning block body view.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct Body(Vec<u8>);

    impl Body {
    	/// Create a new owning block body view. The raw bytes passed in must be an rlp-encoded block
    	/// body.
    	pub fn new(raw: Vec<u8>) -> Self { Body(raw) }

    	/// Get a borrowed view of the data within.
    	#[inline]
    	pub fn view(&self) -> views::BodyView { views::BodyView::new(&self.0) }

    	/// Fully decode this block body.
    	pub fn decode(&self) -> (Vec<UnverifiedTransaction>, Vec<FullHeader>) {
    		(self.view().transactions(), self.view().uncles())
    	}

    	/// Get the RLP of this block body.
    	#[inline]
    	pub fn rlp(&self) -> Rlp {
    		Rlp::new(&self.0)
    	}

    	/// Consume the view and return the raw bytes.
    	pub fn into_inner(self) -> Vec<u8> { self.0 }
    }

    // forwarders to borrowed view.
    impl Body {
    	/// Get a vector of all transactions.
    	pub fn transactions(&self) -> Vec<UnverifiedTransaction> { self.view().transactions() }

    	/// Number of transactions in the block.
    	pub fn transactions_count(&self) -> usize { self.view().transactions_count() }

    	/// A view over each transaction in the block.
    	pub fn transaction_views(&self) -> Vec<views::TransactionView> { self.view().transaction_views() }

    	/// The hash of each transaction in the block.
    	pub fn transaction_hashes(&self) -> Vec<H256> { self.view().transaction_hashes() }

    	/// Decode uncle headers.
    	pub fn uncles(&self) -> Vec<FullHeader> { self.view().uncles() }

    	/// Number of uncles.
    	pub fn uncles_count(&self) -> usize { self.view().uncles_count() }

    	/// Borrowed view over each uncle.
    	pub fn uncle_views(&self) -> Vec<views::HeaderView> { self.view().uncle_views() }

    	/// Hash of each uncle.
    	pub fn uncle_hashes(&self) -> Vec<H256> { self.view().uncle_hashes() }
    }

    /// Owning block view.
    #[derive(Debug, Clone, PartialEq, Eq)]
    #[cfg_attr(feature = "ipc", binary)]
    pub struct Block(Vec<u8>);

    impl Block {
    	/// Create a new owning block view. The raw bytes passed in must be an rlp-encoded block.
    	pub fn new(raw: Vec<u8>) -> Self { Block(raw) }

    	/// Get a borrowed view of the whole block.
    	#[inline]
    	pub fn view(&self) -> views::BlockView { views::BlockView::new(&self.0) }

    	/// Get a borrowed view of the block header.
    	#[inline]
    	pub fn header_view(&self) -> views::HeaderView { self.view().header_view() }

    	/// Decode to a full block.
    	pub fn decode(&self) -> FullBlock { ::rlp::decode(&self.0) }

    	/// Get the rlp of this block.
    	#[inline]
    	pub fn rlp(&self) -> Rlp {
    		Rlp::new(&self.0)
    	}

    	/// Consume the view and return the raw bytes.
    	pub fn into_inner(self) -> Vec<u8> { self.0 }
    }

    // forwarders to borrowed header view.
    impl Block {
    	/// Returns the header hash.
    	pub fn hash(&self) -> H256 { self.header_view().sha3() }

    	/// Returns the parent hash.
    	pub fn parent_hash(&self) -> H256 { self.header_view().parent_hash() }

    	/// Returns the uncles hash.
    	pub fn uncles_hash(&self) -> H256 { self.header_view().uncles_hash() }

    	/// Returns the author.
    	pub fn author(&self) -> Address { self.header_view().author() }

    	/// Returns the state root.
    	pub fn state_root(&self) -> H256 { self.header_view().state_root() }

    	/// Returns the transaction trie root.
    	pub fn transactions_root(&self) -> H256 { self.header_view().transactions_root() }

    	/// Returns the receipts trie root
    	pub fn receipts_root(&self) -> H256 { self.header_view().receipts_root() }

    	/// Returns the block log bloom
    	pub fn log_bloom(&self) -> H2048 { self.header_view().log_bloom() }

    	/// Difficulty of this block
    	pub fn difficulty(&self) -> U256 { self.header_view().difficulty() }

    	/// Number of this block.
    	pub fn number(&self) -> BlockNumber { self.header_view().number() }

    	/// Time this block was produced.
    	pub fn timestamp(&self) -> u64 { self.header_view().timestamp() }

    	/// Gas limit of this block.
    	pub fn gas_limit(&self) -> U256 { self.header_view().gas_limit() }

    	/// Total gas used in this block.
    	pub fn gas_used(&self) -> U256 { self.header_view().gas_used() }

    	/// Block extra data.
    	pub fn extra_data(&self) -> Vec<u8> { self.header_view().extra_data() }

    	/// Engine-specific seal fields.
    	pub fn seal(&self) -> Vec<Vec<u8>> { self.header_view().seal() }
    }

    // forwarders to body view.
    impl Block {
    	/// Get a vector of all transactions.
    	pub fn transactions(&self) -> Vec<UnverifiedTransaction> { self.view().transactions() }

    	/// Number of transactions in the block.
    	pub fn transactions_count(&self) -> usize { self.view().transactions_count() }

    	/// A view over each transaction in the block.
    	pub fn transaction_views(&self) -> Vec<views::TransactionView> { self.view().transaction_views() }

    	/// The hash of each transaction in the block.
    	pub fn transaction_hashes(&self) -> Vec<H256> { self.view().transaction_hashes() }

    	/// Decode uncle headers.
    	pub fn uncles(&self) -> Vec<FullHeader> { self.view().uncles() }

    	/// Number of uncles.
    	pub fn uncles_count(&self) -> usize { self.view().uncles_count() }

    	/// Borrowed view over each uncle.
    	pub fn uncle_views(&self) -> Vec<views::HeaderView> { self.view().uncle_views() }

    	/// Hash of each uncle.
    	pub fn uncle_hashes(&self) -> Vec<H256> { self.view().uncle_hashes() }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)