|
|
<!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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.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 class="location"></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><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><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></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-Log-for-%26T">&T</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In log</a></h2><div id="sidebar-vars" data-name="Log" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../log/index.html">
|
|
|
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
|
|
|
<h1 class="fqn"><span class="in-band">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></span></h1><span class="out-of-band"><a class="srclink" href="../src/log/lib.rs.html#1269-1295">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock 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/core/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" open><summary><div id="tymethod.enabled" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/log/lib.rs.html#1282">source</a></div><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/core/primitive.bool.html">bool</a></h4></div></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" open><summary><div id="tymethod.log" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/log/lib.rs.html#1291">source</a></div><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></div></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" open><summary><div id="tymethod.flush" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/log/lib.rs.html#1294">source</a></div><h4 class="code-header">fn <a href="#tymethod.flush" class="fnname">flush</a>(&self)</h4></div></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"><span class="rightside"><a class="srclink" href="../src/log/lib.rs.html#1309-1323">source</a></span><a href="#impl-Log-for-%26T" class="anchor"></a><h3 class="code-header in-band">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/core/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"><span class="rightside"><a class="srclink" href="../src/log/lib.rs.html#1313-1315">source</a></span><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/core/primitive.bool.html">bool</a></h4></section><section id="method.log" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../src/log/lib.rs.html#1317-1319">source</a></span><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"><span class="rightside"><a class="srclink" href="../src/log/lib.rs.html#1320-1322">source</a></span><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><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../implementors/log/trait.Log.js" async></script></section><section id="search" class="content hidden"></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.62.0-nightly (1f7fb6413 2022-04-10)" ></div>
|
|
|
</body></html> |
