hotpath_meta/
lib.rs

1//! hotpath-rs is a simple async Rust profiler. It instruments functions, channels, futures, and streams to quickly find bottlenecks and focus optimizations where they matter most.
2//! It can provide actionable insights into time, memory, and data flow with minimal setup.
3//! ## Setup & Usage
4//! For a complete setup guide, examples, and advanced configuration, visit
5//! [hotpath.rs](https://hotpath.rs).
6
7// Meta crate mirrors the main crate; some code is conditionally dead
8// depending on feature combinations (e.g. alloc code without global_allocator).
9#![allow(dead_code)]
10
11#[cfg(all(
12    feature = "hotpath-cpu-meta",
13    not(any(target_os = "macos", target_os = "linux"))
14))]
15compile_error!("the `hotpath-cpu-meta` feature is only supported on macOS and Linux");
16
17#[cfg(all(feature = "hotpath-alloc-meta", not(feature = "hotpath-meta")))]
18compile_error!("the `hotpath-alloc-meta` feature requires the `hotpath-meta` feature");
19
20#[cfg(all(feature = "hotpath-cpu-meta", not(feature = "hotpath-meta")))]
21compile_error!("the `hotpath-cpu-meta` feature requires the `hotpath-meta` feature");
22
23#[cfg(all(feature = "hotpath-prometheus-meta", not(feature = "hotpath-meta")))]
24compile_error!("the `hotpath-prometheus-meta` feature requires the `hotpath-meta` feature");
25
26#[cfg(all(feature = "hotpath-cloud-meta", not(feature = "hotpath-meta")))]
27compile_error!("the `hotpath-cloud-meta` feature requires the `hotpath-meta` feature");
28
29#[cfg(feature = "hotpath-meta")]
30#[doc(inline)]
31pub use lib_on::*;
32#[cfg(feature = "hotpath-meta")]
33mod lib_on;
34
35#[cfg(all(feature = "hotpath-meta", feature = "tokio"))]
36pub use lib_on::tokio_runtime;
37
38#[cfg(any(feature = "hotpath-meta", feature = "tui"))]
39pub(crate) mod output;
40#[cfg(feature = "hotpath-meta")]
41pub use output::format_debug_truncated;
42#[cfg(any(feature = "hotpath-meta", feature = "tui"))]
43pub use output::{
44    ceil_char_boundary, floor_char_boundary, format_bytes, format_count, format_duration,
45    format_percentile_header, format_percentile_key, format_rate, parse_bytes, parse_count,
46    parse_duration, shorten_function_name, ProfilingMode, MAX_LOG_LEN,
47};
48
49#[cfg(feature = "hotpath-meta")]
50pub(crate) mod output_on;
51
52#[cfg(feature = "hotpath-meta")]
53#[doc(hidden)]
54pub mod table;
55
56#[cfg(feature = "hotpath-meta")]
57pub(crate) mod auth;
58
59#[cfg(feature = "hotpath-meta")]
60pub(crate) mod metrics_server;
61
62#[cfg(feature = "hotpath-prometheus-meta")]
63pub(crate) mod prometheus_server;
64
65#[cfg(feature = "hotpath-mcp-meta")]
66pub(crate) mod mcp_server;
67
68#[allow(dead_code)]
69#[cfg(any(feature = "hotpath-meta", feature = "tui"))]
70pub mod json;
71#[cfg(any(feature = "hotpath-meta", feature = "tui"))]
72pub use json::Route;
73
74#[cfg(feature = "hotpath-meta")]
75#[doc(hidden)]
76pub mod instant;
77#[cfg(feature = "hotpath-meta")]
78pub(crate) mod tid;
79
80#[cfg(not(feature = "hotpath-meta"))]
81#[doc(inline)]
82pub use lib_off::*;
83#[cfg(not(feature = "hotpath-meta"))]
84mod lib_off;
85
86/// Mirror of `std` paths so instrumented types can be used as drop-in
87/// replacements by prefixing imports with `hotpath_meta::wrap::` (e.g.
88/// `hotpath_meta::wrap::std::sync::RwLock`).
89pub mod wrap {
90    pub mod std {
91        pub mod sync {
92            #[cfg(feature = "hotpath-meta")]
93            pub use crate::lib_on::{
94                mutexes::wrapper::std::{Mutex, MutexGuard},
95                rw_locks::wrapper::std::{RwLock, RwLockReadGuard, RwLockWriteGuard},
96            };
97            #[cfg(not(feature = "hotpath-meta"))]
98            pub use std::sync::{Mutex, MutexGuard, RwLock, RwLockReadGuard, RwLockWriteGuard};
99
100            /// Instrumented `std::sync::mpsc` channel endpoints for
101            /// `channel!(..., wrap = true)`. With `hotpath-meta` enabled these are the
102            /// instrumented wrappers; otherwise `channel!` is a no-op and the endpoints
103            /// are the raw std types, so the alias resolves the same way regardless of
104            /// feature configuration.
105            pub mod mpsc {
106                #[cfg(feature = "hotpath-meta")]
107                pub use crate::lib_on::channels::wrapper::std_wrap::{
108                    Receiver, Sender, SyncSender,
109                };
110                #[cfg(not(feature = "hotpath-meta"))]
111                pub use std::sync::mpsc::{Receiver, Sender, SyncSender};
112            }
113        }
114    }
115
116    /// Instrumented `tokio::sync::mpsc` channel endpoints for
117    /// `channel!(..., wrap = true)`. With `hotpath-meta` enabled these are the
118    /// instrumented wrappers; otherwise `channel!` is a no-op and the endpoints
119    /// are the raw tokio types, so the alias resolves the same way regardless of
120    /// feature configuration.
121    #[cfg(feature = "tokio")]
122    pub mod tokio {
123        pub mod sync {
124            pub mod mpsc {
125                #[cfg(feature = "hotpath-meta")]
126                pub use crate::lib_on::channels::wrapper::tokio_wrap::{
127                    Receiver, Sender, UnboundedReceiver, UnboundedSender, WeakSender,
128                    WeakUnboundedSender,
129                };
130                #[cfg(not(feature = "hotpath-meta"))]
131                pub use tokio::sync::mpsc::{
132                    Receiver, Sender, UnboundedReceiver, UnboundedSender, WeakSender,
133                    WeakUnboundedSender,
134                };
135            }
136        }
137    }
138
139    /// Instrumented crossbeam channel endpoints for `channel!(..., wrap = true)`.
140    /// With `hotpath-meta` enabled these are the instrumented wrappers; otherwise
141    /// `channel!` is a no-op and the endpoints are the raw crossbeam types, so the
142    /// alias resolves the same way regardless of feature configuration.
143    #[cfg(feature = "crossbeam")]
144    pub mod crossbeam {
145        #[cfg(feature = "hotpath-meta")]
146        pub use crate::lib_on::channels::wrapper::crossbeam_wrap::{Receiver, Sender};
147        #[cfg(not(feature = "hotpath-meta"))]
148        pub use crossbeam_channel::{Receiver, Sender};
149    }
150
151    /// Instrumented flume channel endpoints for `channel!(..., wrap = true)`.
152    /// With `hotpath-meta` enabled these are the instrumented wrappers; otherwise
153    /// `channel!` is a no-op and the endpoints are the raw flume types, so the
154    /// alias resolves the same way regardless of feature configuration.
155    #[cfg(feature = "flume")]
156    pub mod flume {
157        #[cfg(feature = "hotpath-meta")]
158        pub use crate::lib_on::channels::wrapper::flume_wrap::{Receiver, Sender};
159        #[cfg(not(feature = "hotpath-meta"))]
160        pub use flume::{Receiver, Sender};
161    }
162
163    /// Instrumented async-channel endpoints for `channel!(..., wrap = true)`.
164    /// With `hotpath-meta` enabled these are the instrumented wrappers; otherwise
165    /// `channel!` is a no-op and the endpoints are the raw async-channel types, so the
166    /// alias resolves the same way regardless of feature configuration.
167    #[cfg(feature = "async-channel")]
168    pub mod async_channel {
169        #[cfg(feature = "hotpath-meta")]
170        pub use crate::lib_on::channels::wrapper::asc_wrap::{Receiver, Sender};
171        #[cfg(not(feature = "hotpath-meta"))]
172        pub use async_channel::{Receiver, Sender};
173    }
174}
175
176mod shared;
177pub use shared::{env_flag, Format, IntoF64, Section};
178
179#[doc(hidden)]
180pub mod dev_logging;
hotpath_meta/lib.rs

hotpath_meta/
lib.rs
