|
|
|
|
|
<!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="API documentation for the Rust `Log` trait in crate `log`."><meta name="keywords" content="rust, rustlang, rust-lang, Log"><title>log::Log - Rust</title><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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a 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><p class='location'>Trait Log</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.enabled">enabled</a><a href="#tymethod.flush">flush</a><a href="#tymethod.log">log</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>log</a></p><script>window.sidebarCurrent = {name: 'Log', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
|
|
|
|
|
|
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/log/lib.rs.html#1124-1142' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>log</a>::<wbr><a class="trait" href=''>Log</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>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="../log/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>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.log' class='fnname'>log</a>(&self, record: &<a class="struct" href="../log/struct.Record.html" title="struct log::Record">Record</a><'_>);
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.flush' class='fnname'>flush</a>(&self);
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>A trait encapsulating the operations required of a logger.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.enabled' class='method'><code>fn <a href='#tymethod.enabled' class='fnname'>enabled</a>(&self, metadata: &<a class="struct" href="../log/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></code></h3><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>
|
|
|
|
|
|
</div><h3 id='tymethod.log' class='method'><code>fn <a href='#tymethod.log' class='fnname'>log</a>(&self, record: &<a class="struct" href="../log/struct.Record.html" title="struct log::Record">Record</a><'_>)</code></h3><div class='docblock'><p>Logs the <code>Record</code>.</p>
|
|
|
|
|
|
<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><h3 id='tymethod.flush' class='method'><code>fn <a href='#tymethod.flush' class='fnname'>flush</a>(&self)</code></h3><div class='docblock'><p>Flushes any buffered records.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/log/trait.Log.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "log";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
