profiling 1.0.16

This crate provides a very thin abstraction over other profiler crates.
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

//
// To use this library, enable one of the feature flags. Each backend implementation provides the
// exact same interface. Only one may be active at a time.
//

// This library itself does not require std, but if any features are enabled, the upstream crate
// likely will bring in std.
#![no_std]

/// Proc macro for creating a scope around each function under struct impl block
/// ```
/// pub struct Foo {
///     // some data...
/// }
///
/// #[profiling::all_functions]
/// impl Foo {
///     pub fn do_something(&self) {
///         // some code...    
///     }
///
///     pub fn do_otherthing(&self) {
///         // some code...
///     }
/// }
/// ```
///
/// The following will generate the same code
///
/// ```
/// pub struct Foo {
///     // some data...
/// }
///
/// impl Foo {
///     #[profiling::function]
///     pub fn do_something(&self) {
///         // some code...    
///     }
///
///     #[profiling::function]
///     pub fn do_otherthing(&self) {
///         // some code...
///     }
/// }
/// ```
#[cfg(feature = "procmacros")]
pub use profiling_procmacros::all_functions;
/// Proc macro for creating a scope around the function, using the name of the function for the
/// scope's name
///
/// This must be done as a proc macro because tracing requires a const string
///
/// ```
/// #[profiling::function]
/// fn my_function() {
///
/// }
/// ```
#[cfg(feature = "procmacros")]
pub use profiling_procmacros::function;
/// Proc macro to skip the auto_impl for the function
/// ```
/// pub struct Foo {
///     // some data...
/// }
///
/// #[profiling::all_functions]
/// impl Foo {
///     pub fn do_something(&self) {
///         // some code...    
///     }
///
///     #[profiling::skip]
///     pub fn do_otherthing(&self) {
///         // some code...
///     }
/// }
/// ```
///
/// The following will generate the same code
///
/// ```
/// pub struct Foo {
///     // some data...
/// }
///
/// impl Foo {
///     #[profiling::function]
///     pub fn do_something(&self) {
///         // some code...    
///     }
///
///     pub fn do_otherthing(&self) {
///         // some code...
///     }
/// }
/// ```
#[cfg(feature = "procmacros")]
pub use profiling_procmacros::skip;

#[cfg(feature = "profile-with-puffin")]
pub use puffin;
#[cfg(feature = "profile-with-puffin")]
mod puffin_impl;
#[cfg(feature = "profile-with-puffin")]
#[allow(unused_imports)]
pub use puffin_impl::*;

#[cfg(feature = "profile-with-optick")]
pub use optick;
#[cfg(feature = "profile-with-optick")]
mod optick_impl;
#[cfg(feature = "profile-with-optick")]
#[allow(unused_imports)]
pub use optick_impl::*;

#[cfg(feature = "profile-with-superluminal")]
pub use superluminal_perf;
#[cfg(feature = "profile-with-superluminal")]
mod superluminal_impl;
#[cfg(feature = "profile-with-superluminal")]
#[allow(unused_imports)]
pub use superluminal_impl::*;

#[cfg(feature = "profile-with-tracing")]
pub use tracing;
#[cfg(feature = "profile-with-tracing")]
mod tracing_impl;
#[cfg(feature = "profile-with-tracing")]
#[allow(unused_imports)]
pub use tracing_impl::*;

#[cfg(feature = "profile-with-tracy")]
pub use tracy_client;
#[cfg(feature = "profile-with-tracy")]
mod tracy_impl;
#[cfg(feature = "profile-with-tracy")]
#[allow(unused_imports)]
pub use tracy_impl::*;

#[cfg(feature = "type-check")]
mod type_check_impl;
#[cfg(feature = "type-check")]
#[allow(unused_imports)]
pub use type_check_impl::*;

#[cfg(not(any(
    feature = "profile-with-puffin",
    feature = "profile-with-optick",
    feature = "profile-with-superluminal",
    feature = "profile-with-tracing",
    feature = "profile-with-tracy",
    feature = "type-check"
)))]
mod empty_impl;

#[cfg(not(any(
    feature = "profile-with-puffin",
    feature = "profile-with-optick",
    feature = "profile-with-superluminal",
    feature = "profile-with-tracing",
    feature = "profile-with-tracy",
    feature = "type-check"
)))]
#[allow(unused_imports)]
pub use empty_impl::*;