      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

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

    use std::fs::File;
    use std::io::Write;
    use std::path::Path;
    use std::collections::BTreeMap;
    use std::time::Duration;
    use serde::{Serialize, Serializer, Error, Deserialize, Deserializer};
    use serde::de::{Visitor, MapVisitor};
    use serde::de::impls::BTreeMapVisitor;
    use serde_json::Value;
    use serde_json::de::from_reader;
    use serde_json::ser::to_string;
    use util::journaldb::Algorithm;
    use ethcore::client::Mode;

    pub struct UserDefaults {
    	pub is_first_launch: bool,
    	pub pruning: Algorithm,
    	pub tracing: bool,
    	pub fat_db: bool,
    	pub mode: Mode,
    }

    impl Serialize for UserDefaults {
    	fn serialize<S>(&self, serializer: &mut S) -> Result<(), S::Error>
    	where S: Serializer {
    		let mut map: BTreeMap<String, Value> = BTreeMap::new();
    		map.insert("pruning".into(), Value::String(self.pruning.as_str().into()));
    		map.insert("tracing".into(), Value::Bool(self.tracing));
    		map.insert("fat_db".into(), Value::Bool(self.fat_db));
    		let mode_str = match self.mode {
    			Mode::Off => "offline",
    			Mode::Dark(timeout) => {
    				map.insert("mode.timeout".into(), Value::U64(timeout.as_secs()));
    				"dark"
    			},
    			Mode::Passive(timeout, alarm) => {
    				map.insert("mode.timeout".into(), Value::U64(timeout.as_secs()));
    				map.insert("mode.alarm".into(), Value::U64(alarm.as_secs()));
    				"passive"
    			},
    			Mode::Active => "active",
    		};
    		map.insert("mode".into(), Value::String(mode_str.into()));

    		map.serialize(serializer)
    	}
    }

    struct UserDefaultsVisitor;

    impl Deserialize for UserDefaults {
    	fn deserialize<D>(deserializer: &mut D) -> Result<Self, D::Error>
    	where D: Deserializer {
    		deserializer.deserialize(UserDefaultsVisitor)
    	}
    }

    impl Visitor for UserDefaultsVisitor {
    	type Value = UserDefaults;

    	fn visit_map<V>(&mut self, visitor: V) -> Result<Self::Value, V::Error>
    	where V: MapVisitor {
    		let mut map: BTreeMap<String, Value> = BTreeMapVisitor::new().visit_map(visitor)?;
    		let pruning: Value = map.remove("pruning").ok_or_else(|| Error::custom("missing pruning"))?;
    		let pruning = pruning.as_str().ok_or_else(|| Error::custom("invalid pruning value"))?;
    		let pruning = pruning.parse().map_err(|_| Error::custom("invalid pruning method"))?;
    		let tracing: Value = map.remove("tracing").ok_or_else(|| Error::custom("missing tracing"))?;
    		let tracing = tracing.as_bool().ok_or_else(|| Error::custom("invalid tracing value"))?;
    		let fat_db: Value = map.remove("fat_db").unwrap_or_else(|| Value::Bool(false));
    		let fat_db = fat_db.as_bool().ok_or_else(|| Error::custom("invalid fat_db value"))?;

    		let mode: Value = map.remove("mode").unwrap_or_else(|| Value::String("active".to_owned()));
    		let mode = match mode.as_str().ok_or_else(|| Error::custom("invalid mode value"))? {
    			"offline" => Mode::Off,
    			"dark" => {
    				let timeout = map.remove("mode.timeout").and_then(|v| v.as_u64()).ok_or_else(|| Error::custom("invalid/missing mode.timeout value"))?;
    				Mode::Dark(Duration::from_secs(timeout))
    			},
    			"passive" => {
    				let timeout = map.remove("mode.timeout").and_then(|v| v.as_u64()).ok_or_else(|| Error::custom("invalid/missing mode.timeout value"))?;
    				let alarm = map.remove("mode.alarm").and_then(|v| v.as_u64()).ok_or_else(|| Error::custom("invalid/missing mode.alarm value"))?;
    				Mode::Passive(Duration::from_secs(timeout), Duration::from_secs(alarm))
    			},
    			"active" => Mode::Active,
    			_ => { return Err(Error::custom("invalid mode value")); },
    		};

    		let user_defaults = UserDefaults {
    			is_first_launch: false,
    			pruning: pruning,
    			tracing: tracing,
    			fat_db: fat_db,
    			mode: mode,
    		};

    		Ok(user_defaults)
    	}
    }

    impl Default for UserDefaults {
    	fn default() -> Self {
    		UserDefaults {
    			is_first_launch: true,
    			pruning: Algorithm::default(),
    			tracing: false,
    			fat_db: false,
    			mode: Mode::Active,
    		}
    	}
    }

    impl UserDefaults {
    	pub fn load<P>(path: P) -> Result<Self, String> where P: AsRef<Path> {
    		match File::open(path) {
    			Ok(file) => match from_reader(file) {
    				Ok(defaults) => Ok(defaults),
    				Err(e) => {
    					warn!("Error loading user defaults file: {:?}", e);
    					Ok(UserDefaults::default())
    				},
    			},
    			_ => Ok(UserDefaults::default()),
    		}
    	}

    	pub fn save<P>(&self, path: P) -> Result<(), String> where P: AsRef<Path> {
    		let mut file: File = File::create(path).map_err(|_| "Cannot create user defaults file".to_owned())?;
    		file.write_all(to_string(&self).unwrap().as_bytes()).map_err(|_| "Failed to save user defaults".to_owned())
    	}
    }

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