| <!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="A trait encapsulating the operations required of a logger."><meta name="keywords" content="rust, rustlang, rust-lang, Log"><title>Log in log - Rust</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="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../log/index.html"><div class="logo-container"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../log/index.html"><div class="logo-container"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></div></a><h2 class="location"><a href="#">Log</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.enabled">enabled</a></li><li><a href="#tymethod.flush">flush</a></li><li><a href="#tymethod.log">log</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-Log-for-%26T">&T</a></li><li><a href="#impl-Log-for-Arc%3CT%3E">Arc<T></a></li><li><a href="#impl-Log-for-Box%3CT%3E">Box<T></a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In log</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Trait <a href="index.html">log</a>::<wbr><a class="trait" href="#">Log</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/log/lib.rs.html#1124-1150">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait Log: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> { |
| fn <a href="#tymethod.enabled" class="fnname">enabled</a>(&self, metadata: &<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.log" class="fnname">log</a>(&self, record: &<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a><'_>); |
| <span class="item-spacer"></span> fn <a href="#tymethod.flush" class="fnname">flush</a>(&self); |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait encapsulating the operations required of a logger.</p> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.enabled" class="method has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1137">source</a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fnname">enabled</a>(&self, metadata: &<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Determines if a log message with the specified metadata would be |
| logged.</p> |
| <p>This is used by the <code>log_enabled!</code> macro to allow callers to avoid |
| expensive computation of log message arguments if the message would be |
| discarded anyway.</p> |
| <h5 id="for-implementors"><a href="#for-implementors">For implementors</a></h5> |
| <p>This method isn’t called automatically by the <code>log!</code> macros. |
| It’s up to an implementation of the <code>Log</code> trait to call <code>enabled</code> in its own |
| <code>log</code> method implementation to guarantee that filtering is applied.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.log" class="method has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1146">source</a><h4 class="code-header">fn <a href="#tymethod.log" class="fnname">log</a>(&self, record: &<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a><'_>)</h4></section></summary><div class="docblock"><p>Logs the <code>Record</code>.</p> |
| <h5 id="for-implementors-1"><a href="#for-implementors-1">For implementors</a></h5> |
| <p>Note that <code>enabled</code> is <em>not</em> necessarily called before this method. |
| Implementations of <code>log</code> should perform all necessary filtering |
| internally.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.flush" class="method has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1149">source</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fnname">flush</a>(&self)</h4></section></summary><div class="docblock"><p>Flushes any buffered records.</p> |
| </div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Log-for-%26T" class="impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1164-1178">source</a><a href="#impl-Log-for-%26T" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a>,</span></h3></section></summary><div class="impl-items"><section id="method.enabled" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1168-1170">source</a><a href="#method.enabled" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fnname">enabled</a>(&self, metadata: &<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.log" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1172-1174">source</a><a href="#method.log" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.log" class="fnname">log</a>(&self, record: &<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a><'_>)</h4></section><section id="method.flush" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1175-1177">source</a><a href="#method.flush" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.flush" class="fnname">flush</a>(&self)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Log-for-Box%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1181-1195">source</a><a href="#impl-Log-for-Box%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><T><span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a>,</span></h3></section></summary><div class="impl-items"><section id="method.enabled-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1185-1187">source</a><a href="#method.enabled-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fnname">enabled</a>(&self, metadata: &<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.log-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1189-1191">source</a><a href="#method.log-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.log" class="fnname">log</a>(&self, record: &<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a><'_>)</h4></section><section id="method.flush-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1192-1194">source</a><a href="#method.flush-1" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.flush" class="fnname">flush</a>(&self)</h4></section></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Log-for-Arc%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1198-1212">source</a><a href="#impl-Log-for-Arc%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><T><span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a>,</span></h3></section></summary><div class="impl-items"><section id="method.enabled-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1202-1204">source</a><a href="#method.enabled-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fnname">enabled</a>(&self, metadata: &<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a><'_>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section><section id="method.log-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1206-1208">source</a><a href="#method.log-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.log" class="fnname">log</a>(&self, record: &<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a><'_>)</h4></section><section id="method.flush-2" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/log/lib.rs.html#1209-1211">source</a><a href="#method.flush-2" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.flush" class="fnname">flush</a>(&self)</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../implementors/log/trait.Log.js" data-ignore-extern-crates="alloc" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="log" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
