blargle 0.1.0

Provides debugging macros which resolves to compiler errors for release builds
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

/// Signifies that the surrounding code is placeholder code and not meant for production.
///
/// For debug builds, this macro resolves to nothing.  For release builds, it generates a compiler error.
#[macro_export]
macro_rules! placeholder {
    () => {
        #[cfg(not(debug_assertions))]
        compile_error!("Placeholder left in code");
    };
}

/// Debug-only version of `std::println`.
///
/// For debug builds, this macro resolves to `std::println!`.  For release builds, it generates a compiler
/// error.
#[macro_export]
macro_rules! println {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        std::println!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `std::print`.
///
/// For debug builds, this macro resolves to `std::print!`.  For release builds, it generates a compiler
/// error.
#[macro_export]
macro_rules! print {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        std::print!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `std::eprintln`.
///
/// For debug builds, this macro resolves to `std::eprintln!`.  For release builds, it generates a compiler
/// error.
#[macro_export]
macro_rules! eprintln {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        std::eprintln!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `std::eprint`.
///
/// For debug builds, this macro resolves to `std::eprint!`.  For release builds, it generates a compiler
/// error.
#[macro_export]
macro_rules! eprint {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        std::eprint!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `std::dbg`.
///
/// For debug builds, this macro resolves to `std::dbg!`.  For release builds, it generates a compiler
/// error.
#[macro_export]
macro_rules! dbg {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        std::dbg!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `log::error`.
///
/// For debug builds, this macro resolves to `log::error!`.  For release builds, it generates a compiler
/// error.
#[cfg(feature = "log")]
#[macro_export]
macro_rules! log_error {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        log::error!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `log::warn`.
///
/// For debug builds, this macro resolves to `log::warn!`.  For release builds, it generates a compiler
/// error.
#[cfg(feature = "log")]
#[macro_export]
macro_rules! log_warn {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        log::warn!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `log::info`.
///
/// For debug builds, this macro resolves to `log::info!`.  For release builds, it generates a compiler
/// error.
#[cfg(feature = "log")]
#[macro_export]
macro_rules! log_info {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        log::info!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `log::debug`.
///
/// For debug builds, this macro resolves to `log::debug!`.  For release builds, it generates a compiler
/// error.
#[cfg(feature = "log")]
#[macro_export]
macro_rules! log_debug {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        log::debug!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}

/// Debug-only version of `log::trace`.
///
/// For debug builds, this macro resolves to `log::trace!`.  For release builds, it generates a compiler
/// error.
#[cfg(feature = "log")]
#[macro_export]
macro_rules! log_trace {
    ($($args:tt)*) => {
        #[cfg(debug_assertions)]
        log::trace!($($args)*);
        #[cfg(not(debug_assertions))]
        compile_error!("Blargle left in code");
    };
}