Google Git
Sign in
fuchsia / third_party / rust-mirrors / rustyline / refs/heads/upstream/gh-pages / . / src / log / macros.rs.html
blob: 0fd8f185df4937e35d4516af4a09cf06e8515235 [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 to the Rust file `/home/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/log-0.3.8/src/macros.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>macros.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<a href='../../log/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="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>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
</pre><pre class="rust ">
<span class="comment">// Copyright 2014-2015 The Rust Project Developers. See the COPYRIGHT</span>
<span class="comment">// file at the top-level directory of this distribution and at</span>
<span class="comment">// http://rust-lang.org/COPYRIGHT.</span>
<span class="comment">//</span>
<span class="comment">// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license</span>
<span class="comment">// &lt;LICENSE-MIT or http://opensource.org/licenses/MIT&gt;, at your</span>
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
<span class="comment">// except according to those terms.</span>
<span class="doccomment">/// The standard logging macro.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This macro will generically log with the specified `LogLevel` and `format!`</span>
<span class="doccomment">/// based argument list.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `max_level_*` features can be used to statically disable logging at</span>
<span class="doccomment">/// various levels.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use]</span>
<span class="doccomment">/// # extern crate log;</span>
<span class="doccomment">/// use log::LogLevel;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// let data = (42, &quot;Forty-two&quot;);</span>
<span class="doccomment">/// let private_data = &quot;private&quot;;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// log!(LogLevel::Error, &quot;Received errors: {}, {}&quot;, data.0, data.1);</span>
<span class="doccomment">/// log!(target: &quot;app_events&quot;, LogLevel::Warn, &quot;App warning: {}, {}, {}&quot;, </span>
<span class="doccomment">/// data.0, data.1, private_data);</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">log</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=&gt;</span> ({
<span class="kw">static</span> <span class="ident">_LOC</span>: <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLocation</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLocation</span> {
<span class="ident">__line</span>: <span class="macro">line</span><span class="macro">!</span>(),
<span class="ident">__file</span>: <span class="macro">file</span><span class="macro">!</span>(),
<span class="ident">__module_path</span>: <span class="macro">module_path</span><span class="macro">!</span>(),
};
<span class="kw">let</span> <span class="ident">lvl</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>;
<span class="kw">if</span> <span class="ident">lvl</span> <span class="op">&lt;=</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">__static_max_level</span>() <span class="op">&amp;&amp;</span> <span class="ident">lvl</span> <span class="op">&lt;=</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">max_log_level</span>() {
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">__log</span>(<span class="ident">lvl</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>, <span class="kw-2">&amp;</span><span class="ident">_LOC</span>, <span class="macro">format_args</span><span class="macro">!</span>($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="op">+</span>))
}
});
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="op">+</span>) <span class="op">=&gt;</span> (<span class="macro">log</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="macro">module_path</span><span class="macro">!</span>(), <span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="op">+</span>))
}
<span class="doccomment">/// Logs a message at the error level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Logging at this level is disabled if the `max_level_off` feature is present.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use]</span>
<span class="doccomment">/// # extern crate log;</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// let (err_info, port) = (&quot;No connection&quot;, 22);</span>
<span class="doccomment">///</span>
<span class="doccomment">/// error!(&quot;Error: {} on port {}&quot;, err_info, port);</span>
<span class="doccomment">/// error!(target: &quot;app_events&quot;, &quot;App Error: {}, Port: {}&quot;, err_info, 22);</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">error</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>, <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Error</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
);
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Error</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
)
}
<span class="doccomment">/// Logs a message at the warn level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Logging at this level is disabled if any of the following features are</span>
<span class="doccomment">/// present: `max_level_off` or `max_level_error`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When building in release mode (i.e., without the `debug_assertions` option),</span>
<span class="doccomment">/// logging at this level is also disabled if any of the following features are</span>
<span class="doccomment">/// present: `release_max_level_off` or `max_level_error`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use]</span>
<span class="doccomment">/// # extern crate log;</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// let warn_description = &quot;Invalid Input&quot;;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// warn!(&quot;Warning! {}!&quot;, warn_description);</span>
<span class="doccomment">/// warn!(target: &quot;input_events&quot;, &quot;App received warning: {}&quot;, warn_description);</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">warn</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>, <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Warn</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
);
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Warn</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
)
}
<span class="doccomment">/// Logs a message at the info level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Logging at this level is disabled if any of the following features are</span>
<span class="doccomment">/// present: `max_level_off`, `max_level_error`, or `max_level_warn`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When building in release mode (i.e., without the `debug_assertions` option),</span>
<span class="doccomment">/// logging at this level is also disabled if any of the following features are</span>
<span class="doccomment">/// present: `release_max_level_off`, `release_max_level_error`, or</span>
<span class="doccomment">/// `release_max_level_warn`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use]</span>
<span class="doccomment">/// # extern crate log;</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// # struct Connection { port: u32, speed: f32 }</span>
<span class="doccomment">/// let conn_info = Connection { port: 40, speed: 3.20 };</span>
<span class="doccomment">///</span>
<span class="doccomment">/// info!(&quot;Connected to port {} at {} Mb/s&quot;, conn_info.port, conn_info.speed);</span>
<span class="doccomment">/// info!(target: &quot;connection_events&quot;, &quot;Successfull connection, port: {}, speed: {}&quot;,</span>
<span class="doccomment">/// conn_info.port, conn_info.speed);</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">info</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>, <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Info</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
);
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Info</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
)
}
<span class="doccomment">/// Logs a message at the debug level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Logging at this level is disabled if any of the following features are</span>
<span class="doccomment">/// present: `max_level_off`, `max_level_error`, `max_level_warn`, or</span>
<span class="doccomment">/// `max_level_info`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When building in release mode (i.e., without the `debug_assertions` option),</span>
<span class="doccomment">/// logging at this level is also disabled if any of the following features are</span>
<span class="doccomment">/// present: `release_max_level_off`, `release_max_level_error`,</span>
<span class="doccomment">/// `release_max_level_warn`, or `release_max_level_info`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use]</span>
<span class="doccomment">/// # extern crate log;</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// # struct Position { x: f32, y: f32 }</span>
<span class="doccomment">/// let pos = Position { x: 3.234, y: -1.223 };</span>
<span class="doccomment">///</span>
<span class="doccomment">/// debug!(&quot;New position: x: {}, y: {}&quot;, pos.x, pos.y);</span>
<span class="doccomment">/// debug!(target: &quot;app_events&quot;, &quot;New position: x: {}, y: {}&quot;, pos.x, pos.y);</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">debug</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>, <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Debug</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
);
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Debug</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
)
}
<span class="doccomment">/// Logs a message at the trace level.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Logging at this level is disabled if any of the following features are</span>
<span class="doccomment">/// present: `max_level_off`, `max_level_error`, `max_level_warn`,</span>
<span class="doccomment">/// `max_level_info`, or `max_level_debug`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// When building in release mode (i.e., without the `debug_assertions` option),</span>
<span class="doccomment">/// logging at this level is also disabled if any of the following features are</span>
<span class="doccomment">/// present: `release_max_level_off`, `release_max_level_error`,</span>
<span class="doccomment">/// `release_max_level_warn`, `release_max_level_info`, or</span>
<span class="doccomment">/// `release_max_level_debug`.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use]</span>
<span class="doccomment">/// # extern crate log;</span>
<span class="doccomment">/// # fn main() {</span>
<span class="doccomment">/// # struct Position { x: f32, y: f32 }</span>
<span class="doccomment">/// let pos = Position { x: 3.234, y: -1.223 };</span>
<span class="doccomment">///</span>
<span class="doccomment">/// trace!(&quot;Position is: x: {}, y: {}&quot;, pos.x, pos.y);</span>
<span class="doccomment">/// trace!(target: &quot;app_events&quot;, &quot;x is {} and y is {}&quot;,</span>
<span class="doccomment">/// if pos.x &gt;= 0.0 { &quot;positive&quot; } else { &quot;negative&quot; },</span>
<span class="doccomment">/// if pos.y &gt;= 0.0 { &quot;positive&quot; } else { &quot;negative&quot; });</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">trace</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>, <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Trace</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
);
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>:<span class="ident">tt</span>)<span class="kw-2">*</span>) <span class="op">=&gt;</span> (
<span class="macro">log</span><span class="macro">!</span>(<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">LogLevel</span>::<span class="ident">Trace</span>, $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">arg</span>)<span class="kw-2">*</span>);
)
}
<span class="doccomment">/// Determines if a message logged at the specified level in that module will</span>
<span class="doccomment">/// be logged.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This can be used to avoid expensive computation of log message arguments if</span>
<span class="doccomment">/// the message would be ignored anyway.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Examples</span>
<span class="doccomment">///</span>
<span class="doccomment">/// ```rust</span>
<span class="doccomment">/// # #[macro_use]</span>
<span class="doccomment">/// # extern crate log;</span>
<span class="doccomment">/// use log::LogLevel::Debug;</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # fn foo() {</span>
<span class="doccomment">/// if log_enabled!(Debug) {</span>
<span class="doccomment">/// let data = expensive_call();</span>
<span class="doccomment">/// debug!(&quot;expensive debug data: {} {}&quot;, data.x, data.y);</span>
<span class="doccomment">/// }</span>
<span class="doccomment">/// # }</span>
<span class="doccomment">/// # struct Data { x: u32, y: u32 }</span>
<span class="doccomment">/// # fn expensive_call() -&gt; Data { Data { x: 0, y: 0 } }</span>
<span class="doccomment">/// # fn main() {}</span>
<span class="doccomment">/// ```</span>
<span class="attribute">#[<span class="ident">macro_export</span>]</span>
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">log_enabled</span> {
(<span class="ident">target</span>: <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>:<span class="ident">expr</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>:<span class="ident">expr</span>) <span class="op">=&gt;</span> ({
<span class="kw">let</span> <span class="ident">lvl</span> <span class="op">=</span> <span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>;
<span class="ident">lvl</span> <span class="op">&lt;=</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">__static_max_level</span>() <span class="op">&amp;&amp;</span> <span class="ident">lvl</span> <span class="op">&lt;=</span> <span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">max_log_level</span>() <span class="op">&amp;&amp;</span>
<span class="macro-nonterminal">$</span><span class="kw">crate</span>::<span class="macro-nonterminal">__enabled</span>(<span class="ident">lvl</span>, <span class="macro-nonterminal">$</span><span class="macro-nonterminal">target</span>)
});
(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>:<span class="ident">expr</span>) <span class="op">=&gt;</span> (<span class="macro">log_enabled</span><span class="macro">!</span>(<span class="ident">target</span>: <span class="macro">module_path</span><span class="macro">!</span>(), <span class="macro-nonterminal">$</span><span class="macro-nonterminal">lvl</span>))
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "log";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>