hotpath 0.9.0

Simple Rust profiler with memory and async data-flow insights - quickly find and debug performance bottlenecks.
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
67
68
69
70
71
72
73

//! A lightweight, easy-to-configure Rust profiler that shows exactly where your code spends time and allocates memory.
//! Instrument any function or code block with to quickly spot bottlenecks, and focus your optimizations where they matter most.
//! ## Setup & Usage
//! For a complete setup guide, examples, and advanced configuration, see the
//! [GitHub repository](https://github.com/pawurb/hotpath-rs).

/// Output format for profiling reports.
///
/// This enum specifies how profiling results should be displayed when the program exits.
///
/// # Variants
///
/// * `Table` - Human-readable table format (default)
/// * `Json` - JSON format
/// * `JsonPretty` - Pretty-printed JSON format
#[derive(Clone, Copy, Debug, Default)]
pub enum Format {
    #[default]
    Table,
    Json,
    JsonPretty,
}

#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
#[doc(inline)]
pub use lib_on::*;
#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
mod lib_on;

#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
pub use lib_on::channels;
#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
pub use lib_on::futures;
#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
pub use lib_on::streams;
#[cfg(all(feature = "hotpath", not(feature = "hotpath-off"), feature = "threads"))]
pub use lib_on::threads;

#[cfg(any(feature = "hotpath", feature = "ci", feature = "tui"))]
pub(crate) mod output;
#[cfg(any(feature = "hotpath", feature = "ci", feature = "tui"))]
pub use output::{
    format_bytes, format_duration, shorten_function_name, FunctionLogsJson, FunctionsDataJson,
    FunctionsJson, MetricType, MetricsProvider, ProfilingMode, Reporter,
};

#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
pub(crate) mod output_on;

#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
pub(crate) mod http_server;

#[cfg(any(feature = "hotpath", feature = "ci", feature = "tui"))]
pub mod json;
#[cfg(any(feature = "hotpath", feature = "ci", feature = "tui"))]
pub use json::Route;

#[cfg(all(feature = "hotpath", not(feature = "hotpath-off")))]
pub(crate) mod tid;

// When hotpath feature is not enabled or hotpath-off is enabled, use no-op stubs
#[cfg(any(not(feature = "hotpath"), feature = "hotpath-off"))]
#[doc(inline)]
pub use lib_off::*;
#[cfg(any(not(feature = "hotpath"), feature = "hotpath-off"))]
mod lib_off;

#[cfg(any(not(feature = "hotpath"), feature = "hotpath-off"))]
pub use lib_off::channels;
#[cfg(any(not(feature = "hotpath"), feature = "hotpath-off"))]
pub use lib_off::futures;
#[cfg(any(not(feature = "hotpath"), feature = "hotpath-off"))]
pub use lib_off::streams;