      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

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

    //! Common log helper functions

    use std::env;
    use rlog::LogLevelFilter;
    use env_logger::LogBuilder;
    use arrayvec::ArrayVec;
    pub use ansi_term::{Colour, Style};

    use parking_lot::{RwLock, RwLockReadGuard};

    lazy_static! {
    	static ref LOG_DUMMY: () = {
    		let mut builder = LogBuilder::new();
    		builder.filter(None, LogLevelFilter::Info);

    		if let Ok(log) = env::var("RUST_LOG") {
    			builder.parse(&log);
    		}

    		if builder.init().is_ok() {
    			println!("logger initialized");
    		}
    	};
    }

    /// Intialize log with default settings
    pub fn init_log() {
    	*LOG_DUMMY
    }

    const LOG_SIZE : usize = 128;

    /// Logger implementation that keeps up to `LOG_SIZE` log elements.
    pub struct RotatingLogger {
    	/// Defined logger levels
    	levels: String,
    	/// Logs array. Latest log is always at index 0
    	logs: RwLock<ArrayVec<[String; LOG_SIZE]>>,
    }

    impl RotatingLogger {

    	/// Creates new `RotatingLogger` with given levels.
    	/// It does not enforce levels - it's just read only.
    	pub fn new(levels: String) -> Self {
    		RotatingLogger {
    			levels: levels,
    			logs: RwLock::new(ArrayVec::<[_; LOG_SIZE]>::new()),
    		}
    	}

    	/// Append new log entry
    	pub fn append(&self, log: String) {
    		self.logs.write().insert(0, log);
    	}

    	/// Return levels
    	pub fn levels(&self) -> &str {
    		&self.levels
    	}

    	/// Return logs
    	pub fn logs(&self) -> RwLockReadGuard<ArrayVec<[String; LOG_SIZE]>> {
    		self.logs.read()
    	}

    }

    #[cfg(test)]
    mod test {
    	use super::RotatingLogger;

    	fn logger() -> RotatingLogger {
    		RotatingLogger::new("test".to_owned())
    	}

    	#[test]
    	fn should_return_log_levels() {
    		// given
    		let logger = logger();

    		// when
    		let levels = logger.levels();

    		// then
    		assert_eq!(levels, "test");
    	}

    	#[test]
    	fn should_return_latest_logs() {
    		// given
    		let logger = logger();

    		// when
    		logger.append("a".to_owned());
    		logger.append("b".to_owned());

    		// then
    		let logs = logger.logs();
    		assert_eq!(logs[0], "b".to_owned());
    		assert_eq!(logs[1], "a".to_owned());
    		assert_eq!(logs.len(), 2);
    	}
    }

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