blob: 2d1e4c7aa73f0c2570a122359601a4d509c173f0 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/tracing-0.1.37/src/level_filters.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>level_filters.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../tracing/index.html"><div class="logo-container">
<img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../tracing/index.html">
<img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
</pre><pre class="rust"><code><span class="doccomment">//! Trace verbosity level filtering.
//!
//! # Compile time filters
//!
//! Trace verbosity levels can be statically disabled at compile time via Cargo
//! features, similar to the [`log` crate]. Trace instrumentation at disabled
//! levels will be skipped and will not even be present in the resulting binary
//! unless the verbosity level is specified dynamically. This level is
//! configured separately for release and debug builds. The features are:
//!
//! * `max_level_off`
//! * `max_level_error`
//! * `max_level_warn`
//! * `max_level_info`
//! * `max_level_debug`
//! * `max_level_trace`
//! * `release_max_level_off`
//! * `release_max_level_error`
//! * `release_max_level_warn`
//! * `release_max_level_info`
//! * `release_max_level_debug`
//! * `release_max_level_trace`
//!
//! These features control the value of the `STATIC_MAX_LEVEL` constant. The
//! instrumentation macros macros check this value before recording an event or
//! constructing a span. By default, no levels are disabled.
//!
//! For example, a crate can disable trace level instrumentation in debug builds
//! and trace, debug, and info level instrumentation in release builds with the
//! following configuration:
//!
//! ```toml
//! [dependencies]
//! tracing = { version = &quot;0.1&quot;, features = [&quot;max_level_debug&quot;, &quot;release_max_level_warn&quot;] }
//! ```
//! ## Notes
//!
//! Please note that `tracing`&#39;s static max level features do *not* control the
//! [`log`] records that may be emitted when [`tracing`&#39;s &quot;log&quot; feature flag][f] is
//! enabled. This is to allow `tracing` to be disabled entirely at compile time
//! while still emitting `log` records --- such as when a library using
//! `tracing` is used by an application using `log` that doesn&#39;t want to
//! generate any `tracing`-related code, but does want to collect `log` records.
//!
//! This means that if the &quot;log&quot; feature is in use, some code may be generated
//! for `log` records emitted by disabled `tracing` events. If this is not
//! desirable, `log` records may be disabled separately using [`log`&#39;s static
//! max level features][`log` crate].
//!
//! [`log`]: https://docs.rs/log/
//! [`log` crate]: https://docs.rs/log/latest/log/#compile-time-filters
//! [f]: https://docs.rs/tracing/latest/tracing/#emitting-log-records
</span><span class="kw">pub use </span>tracing_core::{metadata::ParseLevelFilterError, LevelFilter};
<span class="doccomment">/// The statically configured maximum trace level.
///
/// See the [module-level documentation] for information on how to configure
/// this.
///
/// This value is checked by the `event!` and `span!` macros. Code that
/// manually constructs events or spans via the `Event::record` function or
/// `Span` constructors should compare the level against this value to
/// determine if those spans or events are enabled.
///
/// [module-level documentation]: super#compile-time-filters
</span><span class="kw">pub const </span>STATIC_MAX_LEVEL: LevelFilter = MAX_LEVEL;
<span class="macro">cfg_if::cfg_if! </span>{
<span class="kw">if </span><span class="attribute">#[cfg(all(not(debug_assertions), feature = <span class="string">&quot;release_max_level_off&quot;</span>))] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::OFF;
} <span class="kw">else if </span><span class="attribute">#[cfg(all(not(debug_assertions), feature = <span class="string">&quot;release_max_level_error&quot;</span>))] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::ERROR;
} <span class="kw">else if </span><span class="attribute">#[cfg(all(not(debug_assertions), feature = <span class="string">&quot;release_max_level_warn&quot;</span>))] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::WARN;
} <span class="kw">else if </span><span class="attribute">#[cfg(all(not(debug_assertions), feature = <span class="string">&quot;release_max_level_info&quot;</span>))] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::INFO;
} <span class="kw">else if </span><span class="attribute">#[cfg(all(not(debug_assertions), feature = <span class="string">&quot;release_max_level_debug&quot;</span>))] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::DEBUG;
} <span class="kw">else if </span><span class="attribute">#[cfg(all(not(debug_assertions), feature = <span class="string">&quot;release_max_level_trace&quot;</span>))] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::TRACE;
} <span class="kw">else if </span><span class="attribute">#[cfg(feature = <span class="string">&quot;max_level_off&quot;</span>)] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::OFF;
} <span class="kw">else if </span><span class="attribute">#[cfg(feature = <span class="string">&quot;max_level_error&quot;</span>)] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::ERROR;
} <span class="kw">else if </span><span class="attribute">#[cfg(feature = <span class="string">&quot;max_level_warn&quot;</span>)] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::WARN;
} <span class="kw">else if </span><span class="attribute">#[cfg(feature = <span class="string">&quot;max_level_info&quot;</span>)] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::INFO;
} <span class="kw">else if </span><span class="attribute">#[cfg(feature = <span class="string">&quot;max_level_debug&quot;</span>)] </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::DEBUG;
} <span class="kw">else </span>{
<span class="kw">const </span>MAX_LEVEL: LevelFilter = LevelFilter::TRACE;
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tracing" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>