benchkit/
lib.rs

1//! Lightweight benchmarking toolkit focused on practical performance analysis and report generation.
2#![ cfg_attr( doc, doc = include_str!( concat!( env!( "CARGO_MANIFEST_DIR" ), "/", "readme.md" ) ) ) ]
3#![ doc( html_logo_url = "https://raw.githubusercontent.com/Wandalen/wTools/master/asset/img/logo_v3_trans_square.png" ) ]
4#![ doc(
5  html_favicon_url = "https://raw.githubusercontent.com/Wandalen/wTools/alpha/asset/img/logo_v3_trans_square_icon_small_v2.ico"
6) ]
7#![ doc( html_root_url = "https://docs.rs/benchkit/latest/benchkit/" ) ]
8#![ allow( clippy::std_instead_of_core ) ]
9#![ allow( clippy::format_push_string ) ]
10#![ allow( clippy::must_use_candidate ) ]
11#![ allow( clippy::uninlined_format_args ) ]
12#![ allow( clippy::doc_markdown ) ]
13#![ allow( clippy::missing_errors_doc ) ]
14#![ allow( clippy::implicit_hasher ) ]
15#![ allow( clippy::cast_possible_truncation ) ]
16#![ allow( clippy::needless_pass_by_value ) ]
17#![ allow( clippy::redundant_closure_for_method_calls ) ]
18#![ allow( clippy::cast_sign_loss ) ]
19#![ allow( clippy::used_underscore_binding ) ]
20#![ allow( clippy::missing_panics_doc ) ]
21#![ allow( clippy::return_self_not_must_use ) ]
22#![ allow( clippy::useless_format ) ]
23#![ allow( clippy::if_not_else ) ]
24#![ allow( clippy::unnecessary_wraps ) ]
25#![ allow( clippy::cloned_instead_of_copied ) ]
26#![ allow( clippy::unnecessary_debug_formatting ) ]
27#![ allow( clippy::needless_borrows_for_generic_args ) ]
28#![ allow( clippy::inherent_to_string ) ]
29#![ allow( clippy::unnecessary_map_or ) ]
30#![ allow( clippy::unused_self ) ]
31#![ allow( clippy::too_many_lines ) ]
32#![ allow( clippy::needless_borrow ) ]
33#![ allow( clippy::single_char_add_str ) ]
34#![ allow( clippy::match_same_arms ) ]
35#![ allow( clippy::empty_line_after_outer_attr ) ]
36#![ allow( clippy::similar_names ) ]
37#![ allow( clippy::uninlined_format_args ) ]
38#![ allow( clippy::format_push_string ) ]
39#![ allow( unused_imports ) ]
40
41#[ cfg( feature = "enabled" ) ]
42pub mod measurement;
43
44#[ cfg( feature = "enabled" ) ]
45pub mod analysis;
46
47#[ cfg( feature = "enabled" ) ]
48pub mod suite;
49
50#[ cfg( feature = "markdown_reports" ) ]
51pub mod reporting;
52
53#[ cfg( feature = "data_generators" ) ]
54pub mod generators;
55
56#[ cfg( feature = "enabled" ) ]
57pub mod scaling;
58
59#[ cfg( feature = "enabled" ) ]
60pub mod profiling;
61
62#[ cfg( feature = "markdown_reports" ) ]
63pub mod documentation;
64
65#[ cfg( feature = "enabled" ) ]
66pub mod comparison;
67
68#[ cfg( feature = "diff_analysis" ) ]
69pub mod diff;
70
71#[ cfg( feature = "visualization" ) ]
72pub mod plotting;
73
74#[ cfg( feature = "statistical_analysis" ) ]
75pub mod statistical;
76
77#[ cfg( feature = "enabled" ) ]
78pub mod data_generation;
79
80#[ cfg( feature = "enabled" ) ]
81pub mod throughput;
82
83#[ cfg( feature = "enabled" ) ]
84pub mod memory_tracking;
85
86#[ cfg( feature = "enabled" ) ]
87pub mod parser_analysis;
88
89#[ cfg( feature = "enabled" ) ]
90pub mod parser_data_generation;
91
92/// Prelude module for convenient imports
93#[ cfg( feature = "enabled" ) ]
94pub mod prelude
95{
96  pub use crate::measurement::*;
97  pub use crate::analysis::*;
98  pub use crate::suite::*;
99  pub use std::time::{Duration, Instant};
100
101  #[ cfg( feature = "markdown_reports" ) ]
102  pub use crate::reporting::*;
103
104  #[ cfg( feature = "data_generators" ) ]
105  pub use crate::generators::*;
106  
107  pub use crate::scaling::*;
108  pub use crate::profiling::*;
109  pub use crate::comparison::*;
110  
111  #[ cfg( feature = "markdown_reports" ) ]
112  pub use crate::documentation::*;
113  
114  #[ cfg( feature = "diff_analysis" ) ]
115  pub use crate::diff::*;
116  
117  #[ cfg( feature = "visualization" ) ]
118  pub use crate::plotting::*;
119  
120  #[ cfg( feature = "statistical_analysis" ) ]
121  pub use crate::statistical::*;
122  
123  pub use crate::data_generation::*;
124  pub use crate::throughput::*;
125  pub use crate::memory_tracking::*;
126  pub use crate::parser_analysis::*;
127  pub use crate::parser_data_generation::*;
128}
benchkit/lib.rs

benchkit/
lib.rs
