hipcheck-sdk 0.7.0

SDK for writing Hipcheck plugins in Rust
Documentation 
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

// SPDX-License-Identifier: Apache-2.0

//! Special tools/utilities for benchmarking.
//!
//! The way this is intended to work is that when the "print-timings" feature is enabled,
//! various lines of code that create instantiate structs like [PrintTime] will be activated.
//!
//! These structs have a special [Drop] implementation that prints the duration between instantiation and when they
//! are dropped, effectively giving us function timings without being too intrusive to the codebase.
//!
//! A macro is provided to automatically tag timings with the file and line number that they were created on.

use console::style;
use std::time::Instant;

/// Structure used to track timing that will print its location and elapsed time when dropped.
#[derive(Debug)]
pub struct PrintTime {
	pub location: String,
	pub start: Instant,
}

impl PrintTime {
	/// Create a new [PrintTime] that will print the number of seconds it was alive for when it gets dropped.
	pub fn new(location: impl Into<String>) -> Self {
		PrintTime {
			location: location.into(),
			start: Instant::now(),
		}
	}
}

impl Drop for PrintTime {
	fn drop(&mut self) {
		let PrintTime { location, start } = self;
		eprintln!(
			"[TIMINGS]: {}: {:.6} seconds elapsed.",
			style(location).bold(),
			(Instant::now() - *start).as_secs_f64()
		);
	}
}

macro_rules! print_scope_time {
	() => {
		$crate::benchmarking::PrintTime::new(format!(
			"{}:{}:{}",
			module_path!(),
			line!(),
			column!()
		))
	};

	($msg:expr) => {
		$crate::benchmarking::PrintTime::new(format!(
			"{}:{}:{} ({})",
			module_path!(),
			line!(),
			column!(),
			$msg
		))
	};
}

// Make `print_scope_time` available through `benchmarking` module
pub(super) use print_scope_time;