brunch 0.4.0

A simple micro-benchmark runner.
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

/*!
# Brunch
*/

use dactyl::NiceU32;
use std::fmt;



#[derive(Debug, Clone, Copy)]
/// # Error.
///
/// This enum serves as the custom error type for `Brunch`.
pub enum BrunchError {
	/// # Duplicate name.
	DupeName,

	/// # No benches were specified.
	NoBench,

	/// # A bench was missing a [`Bench::run`](crate::Bench::run)-type call.
	NoRun,

	/// # General math failure. (Floats aren't fun.)
	Overflow,

	/// # The benchmark completed too quickly to analyze.
	TooFast,

	/// # Not enough samples were collected to analyze.
	TooSmall(u32),

	/// # The samples were too chaotic to analyze.
	TooWild,
}

impl std::error::Error for BrunchError {}

impl fmt::Display for BrunchError {
	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
		match self {
			Self::DupeName => f.write_str("Benchmark names must be unique."),
			Self::NoBench => f.write_str("At least one benchmark is required."),
			Self::NoRun => f.write_str("Missing \x1b[1;96mBench::run\x1b[0m."),
			Self::Overflow => f.write_str("Unable to crunch the numbers."),
			Self::TooFast => f.write_str("Too fast to benchmark!"),
			Self::TooSmall(n) => write!(
				f, "Insufficient samples collected ({}); try increasing the timeout.",
				NiceU32::from(*n),
			),
			Self::TooWild => f.write_str("Samples too wild to analyze."),
		}
	}
}