Files
GopherGate/target/doc/log/macro.log_enabled.html
2026-02-26 12:00:21 -05:00

28 lines
4.9 KiB
HTML

<!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="Determines if a message logged at the specified level in that module will be logged."><title>log_enabled in log - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="log" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://prev.rust-lang.org/favicon.ico"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">log_enabled</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../log/index.html"><img src="https://prev.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></a><h2><a href="../log/index.html">log</a><span class="version">0.4.29</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">log_<wbr>enabled</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate log</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">log</a></div><h1>Macro <span class="macro">log_<wbr>enabled</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/log/macros.rs.html#391-411">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! log_enabled {
(logger: $logger:expr, target: $target:expr, $lvl:expr) =&gt; { ... };
(logger: $logger:expr, $lvl:expr) =&gt; { ... };
(target: $target:expr, $lvl:expr) =&gt; { ... };
($lvl:expr) =&gt; { ... };
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Determines if a message logged at the specified level in that module will
be logged.</p>
<p>This can be used to avoid expensive computation of log message arguments if
the message would be ignored anyway.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>log::{debug, log_enabled, Level};
<span class="kw">if </span><span class="macro">log_enabled!</span>(Level::Debug) {
<span class="kw">let </span>data = expensive_call();
<span class="macro">debug!</span>(<span class="string">"expensive debug data: {} {}"</span>, data.x, data.y);
}
<span class="kw">if </span><span class="macro">log_enabled!</span>(target: <span class="string">"Global"</span>, Level::Debug) {
<span class="kw">let </span>data = expensive_call();
<span class="macro">debug!</span>(target: <span class="string">"Global"</span>, <span class="string">"expensive debug data: {} {}"</span>, data.x, data.y);
}
<span class="kw">if </span><span class="macro">log_enabled!</span>(logger: my_logger, Level::Debug) {
<span class="kw">let </span>data = expensive_call();
<span class="macro">debug!</span>(target: <span class="string">"Global"</span>, <span class="string">"expensive debug data: {} {}"</span>, data.x, data.y);
}</code></pre></div>
<p>This macro accepts the same <code>target</code> and <code>logger</code> arguments as <a href="macro.log.html" title="macro log::log"><code>log</code></a>.</p>
</div></details></section></div></main></body></html>