edlang/log/trait.Log.html
2024-07-26 09:42:18 +00:00

28 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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."><title>Log in log - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.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" title="show sidebar"></button><a class="logo-container" href="../log/index.html"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../log/index.html"><img src="https://www.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.22</span></h2></div><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">&amp;T</a></li><li><a href="#impl-Log-for-Arc%3CT%3E">Arc&lt;T&gt;</a></li><li><a href="#impl-Log-for-Box%3CT%3E">Box&lt;T&gt;</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate log</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">log</a>::<wbr><a class="trait" href="#">Log</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/log/lib.rs.html#1166-1197">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Log: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> {
// Required methods
fn <a href="#tymethod.enabled" class="fn">enabled</a>(&amp;self, metadata: &amp;<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a>&lt;'_&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.log" class="fn">log</a>(&amp;self, record: &amp;<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a>&lt;'_&gt;);
<span class="item-spacer"></span> fn <a href="#tymethod.flush" class="fn">flush</a>(&amp;self);
}</code></pre><details class="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="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.enabled" class="method"><a class="src rightside" href="../src/log/lib.rs.html#1179">source</a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fn">enabled</a>(&amp;self, metadata: &amp;<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a>&lt;'_&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/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 class="doc-anchor" href="#for-implementors">§</a>For implementors</h5>
<p>This method isnt called automatically by the <code>log!</code> macros.
Its 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="toggle method-toggle" open><summary><section id="tymethod.log" class="method"><a class="src rightside" href="../src/log/lib.rs.html#1188">source</a><h4 class="code-header">fn <a href="#tymethod.log" class="fn">log</a>(&amp;self, record: &amp;<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a>&lt;'_&gt;)</h4></section></summary><div class="docblock"><p>Logs the <code>Record</code>.</p>
<h5 id="for-implementors-1"><a class="doc-anchor" href="#for-implementors-1">§</a>For implementors</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="toggle method-toggle" open><summary><section id="tymethod.flush" class="method"><a class="src rightside" href="../src/log/lib.rs.html#1196">source</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&amp;self)</h4></section></summary><div class="docblock"><p>Flushes any buffered records.</p>
<h5 id="for-implementors-2"><a class="doc-anchor" href="#for-implementors-2">§</a>For implementors</h5>
<p>This method isnt called automatically by the <code>log!</code> macros.
It can be called manually on shut-down to ensure any in-flight records are flushed.</p>
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-Log-for-%26T" class="impl"><a class="src rightside" href="../src/log/lib.rs.html#1211-1225">source</a><a href="#impl-Log-for-%26T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a> for <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;T</a><div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/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>,</div></h3></section></summary><div class="impl-items"><section id="method.enabled" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1215-1217">source</a><a href="#method.enabled" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fn">enabled</a>(&amp;self, metadata: &amp;<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a>&lt;'_&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section><section id="method.log" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1219-1221">source</a><a href="#method.log" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.log" class="fn">log</a>(&amp;self, record: &amp;<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a>&lt;'_&gt;)</h4></section><section id="method.flush" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1222-1224">source</a><a href="#method.flush" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&amp;self)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Log-for-Box%3CT%3E" class="impl"><a class="src rightside" href="../src/log/lib.rs.html#1228-1242">source</a><a href="#impl-Log-for-Box%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a> for <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a>&lt;T&gt;<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/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>,</div></h3></section></summary><div class="impl-items"><section id="method.enabled-1" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1232-1234">source</a><a href="#method.enabled-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fn">enabled</a>(&amp;self, metadata: &amp;<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a>&lt;'_&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section><section id="method.log-1" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1236-1238">source</a><a href="#method.log-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.log" class="fn">log</a>(&amp;self, record: &amp;<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a>&lt;'_&gt;)</h4></section><section id="method.flush-1" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1239-1241">source</a><a href="#method.flush-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&amp;self)</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Log-for-Arc%3CT%3E" class="impl"><a class="src rightside" href="../src/log/lib.rs.html#1245-1259">source</a><a href="#impl-Log-for-Arc%3CT%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="trait.Log.html" title="trait log::Log">Log</a> for <a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;T&gt;<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/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>,</div></h3></section></summary><div class="impl-items"><section id="method.enabled-2" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1249-1251">source</a><a href="#method.enabled-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.enabled" class="fn">enabled</a>(&amp;self, metadata: &amp;<a class="struct" href="struct.Metadata.html" title="struct log::Metadata">Metadata</a>&lt;'_&gt;) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section><section id="method.log-2" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1253-1255">source</a><a href="#method.log-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.log" class="fn">log</a>(&amp;self, record: &amp;<a class="struct" href="struct.Record.html" title="struct log::Record">Record</a>&lt;'_&gt;)</h4></section><section id="method.flush-2" class="method trait-impl"><a class="src rightside" href="../src/log/lib.rs.html#1256-1258">source</a><a href="#method.flush-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.flush" class="fn">flush</a>(&amp;self)</h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/log/trait.Log.js" data-ignore-extern-crates="alloc" async></script></section></div></main></body></html>