grafeo-common 0.5.41

Common types, memory allocators, and utilities for Grafeo
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

//! Conditional tracing macros.
//!
//! When the `tracing` feature is enabled these expand to the corresponding
//! [`tracing`] crate macros. When disabled they compile to nothing, giving
//! zero overhead for profiles like `embedded` and `browser`.

/// Zero-sized span guard returned when tracing is disabled.
///
/// Allows `let _span = grafeo_debug_span!(...)` to compile without
/// triggering clippy's `let_unit_value` lint.
pub struct NoopSpan;

/// Enters an info-level span. Returns a guard that keeps the span open.
#[macro_export]
macro_rules! grafeo_info_span {
    ($($arg:tt)*) => {{
        #[cfg(feature = "tracing")]
        { ::tracing::info_span!($($arg)*).entered() }
        #[cfg(not(feature = "tracing"))]
        { $crate::tracing_macros::NoopSpan }
    }};
}

/// Enters a debug-level span.
#[macro_export]
macro_rules! grafeo_debug_span {
    ($($arg:tt)*) => {{
        #[cfg(feature = "tracing")]
        { ::tracing::debug_span!($($arg)*).entered() }
        #[cfg(not(feature = "tracing"))]
        { $crate::tracing_macros::NoopSpan }
    }};
}

/// Emits a warn-level event.
///
/// When the `tracing` feature is disabled, the format string and its arguments
/// are still referenced (via `format_args!`) so that variables captured in the
/// message do not trigger `unused_variable` warnings. The compiler optimises
/// the dead `format_args!` call away entirely.
#[macro_export]
macro_rules! grafeo_warn {
    ($($arg:tt)*) => {{
        #[cfg(feature = "tracing")]
        { ::tracing::warn!($($arg)*); }
        #[cfg(not(feature = "tracing"))]
        { if false { let _ = format_args!($($arg)*); } }
    }};
}

/// Emits an info-level event.
#[macro_export]
macro_rules! grafeo_info {
    ($($arg:tt)*) => {{
        #[cfg(feature = "tracing")]
        { ::tracing::info!($($arg)*); }
        #[cfg(not(feature = "tracing"))]
        { if false { let _ = format_args!($($arg)*); } }
    }};
}

/// Emits a debug-level event.
#[macro_export]
macro_rules! grafeo_debug {
    ($($arg:tt)*) => {{
        #[cfg(feature = "tracing")]
        { ::tracing::debug!($($arg)*); }
        #[cfg(not(feature = "tracing"))]
        { if false { let _ = format_args!($($arg)*); } }
    }};
}

/// Emits an error-level event.
#[macro_export]
macro_rules! grafeo_error {
    ($($arg:tt)*) => {{
        #[cfg(feature = "tracing")]
        { ::tracing::error!($($arg)*); }
        #[cfg(not(feature = "tracing"))]
        { if false { let _ = format_args!($($arg)*); } }
    }};
}