      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

    // 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/>.

    //! General error types for use in ethcore.

    use rustc_serialize::hex::FromHexError;
    use rlp::DecoderError;
    use std::fmt;
    use hash::H256;

    #[derive(Debug)]
    /// Error in database subsystem.
    pub enum BaseDataError {
    	/// An entry was removed more times than inserted.
    	NegativelyReferencedHash(H256),
    	/// A committed value was inserted more than once.
    	AlreadyExists(H256),
    }

    impl fmt::Display for BaseDataError {
    	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    		match *self {
    			BaseDataError::NegativelyReferencedHash(hash) =>
    				write!(f, "Entry {} removed from database more times than it was added.", hash),
    			BaseDataError::AlreadyExists(hash) =>
    				write!(f, "Committed key already exists in database: {}", hash),
    		}
    	}
    }

    #[derive(Debug)]
    /// General error type which should be capable of representing all errors in ethcore.
    pub enum UtilError {
    	/// Error concerning the Rust standard library's IO subsystem.
    	StdIo(::std::io::Error),
    	/// Error concerning the hex conversion logic.
    	FromHex(FromHexError),
    	/// Error concerning the database abstraction logic.
    	BaseData(BaseDataError),
    	/// Error concerning the RLP decoder.
    	Decoder(DecoderError),
    	/// Miscellaneous error described by a string.
    	SimpleString(String),
    	/// Error from a bad input size being given for the needed output.
    	BadSize,
    	/// Error from snappy.
    	Snappy(::snappy::InvalidInput),
    }

    impl fmt::Display for UtilError {
    	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    		match *self {
    			UtilError::StdIo(ref err) => f.write_fmt(format_args!("{}", err)),
    			UtilError::FromHex(ref err) => f.write_fmt(format_args!("{}", err)),
    			UtilError::BaseData(ref err) => f.write_fmt(format_args!("{}", err)),
    			UtilError::Decoder(ref err) => f.write_fmt(format_args!("{}", err)),
    			UtilError::SimpleString(ref msg) => f.write_str(msg),
    			UtilError::BadSize => f.write_str("Bad input size."),
    			UtilError::Snappy(ref err) => f.write_fmt(format_args!("{}", err)),
    		}
    	}
    }

    #[derive(Debug, PartialEq, Eq, Clone, Copy)]
    /// Error indicating an expected value was not found.
    pub struct Mismatch<T: fmt::Debug> {
    	/// Value expected.
    	pub expected: T,
    	/// Value found.
    	pub found: T,
    }

    impl<T: fmt::Debug + fmt::Display> fmt::Display for Mismatch<T> {
    	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    		f.write_fmt(format_args!("Expected {}, found {}", self.expected, self.found))
    	}
    }

    #[derive(Debug, PartialEq, Eq, Clone, Copy)]
    /// Error indicating value found is outside of a valid range.
    pub struct OutOfBounds<T: fmt::Debug> {
    	/// Minimum allowed value.
    	pub min: Option<T>,
    	/// Maximum allowed value.
    	pub max: Option<T>,
    	/// Value found.
    	pub found: T,
    }

    impl<T: fmt::Debug + fmt::Display> fmt::Display for OutOfBounds<T> {
    	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
    		let msg = match (self.min.as_ref(), self.max.as_ref()) {
    			(Some(min), Some(max)) => format!("Min={}, Max={}", min, max),
    			(Some(min), _) => format!("Min={}", min),
    			(_, Some(max)) => format!("Max={}", max),
    			(None, None) => "".into(),
    		};

    		f.write_fmt(format_args!("Value {} out of bounds. {}", self.found, msg))
    	}
    }

    impl From<FromHexError> for UtilError {
    	fn from(err: FromHexError) -> UtilError {
    		UtilError::FromHex(err)
    	}
    }

    impl From<BaseDataError> for UtilError {
    	fn from(err: BaseDataError) -> UtilError {
    		UtilError::BaseData(err)
    	}
    }

    impl From<::std::io::Error> for UtilError {
    	fn from(err: ::std::io::Error) -> UtilError {
    		UtilError::StdIo(err)
    	}
    }

    impl From<::rlp::DecoderError> for UtilError {
    	fn from(err: ::rlp::DecoderError) -> UtilError {
    		UtilError::Decoder(err)
    	}
    }

    impl From<String> for UtilError {
    	fn from(err: String) -> UtilError {
    		UtilError::SimpleString(err)
    	}
    }

    impl From<::snappy::InvalidInput> for UtilError {
    	fn from(err: ::snappy::InvalidInput) -> UtilError {
    		UtilError::Snappy(err)
    	}
    }

    // TODO: uncomment below once https://github.com/rust-lang/rust/issues/27336 sorted.
    /*#![feature(concat_idents)]
    macro_rules! assimilate {
        ($name:ident) => (
    		impl From<concat_idents!($name, Error)> for Error {
    			fn from(err: concat_idents!($name, Error)) -> Error {
    				Error:: $name (err)
    			}
    		}
        )
    }
    assimilate!(FromHex);
    assimilate!(BaseData);*/

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