edlang/tracing_subscriber/fmt/time/trait.FormatTime.html
2024-02-13 06:38:44 +00:00

17 lines
13 KiB
HTML
Raw 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 type that can measure and format the current time."><title>FormatTime in tracing_subscriber::fmt::time - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="tracing_subscriber" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></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">&#9776;</button><a class="logo-container" href="../../../tracing_subscriber/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../tracing_subscriber/index.html"><img src="https://raw.githubusercontent.com/tokio-rs/tracing/master/assets/logo-type.png" alt="logo"></a><h2><a href="../../../tracing_subscriber/index.html">tracing_subscriber</a><span class="version">0.3.18</span></h2></div><h2 class="location"><a href="#">FormatTime</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.format_time">format_time</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-FormatTime-for-%26F">&amp;&#x27;a F</a></li><li><a href="#impl-FormatTime-for-()">()</a></li><li><a href="#impl-FormatTime-for-fn(%26mut+Writer%3C'b%3E)+-%3E+Result%3C(),+Error%3E">fn(_: &amp;mut Writer&lt;&#x27;_&gt;) -&gt; Result</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In tracing_subscriber::fmt::time</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../tracing_subscriber/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../../index.html">tracing_subscriber</a>::<wbr><a href="../index.html">fmt</a>::<wbr><a href="index.html">time</a>::<wbr><a class="trait" href="#">FormatTime</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#47-54">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 FormatTime {
// Required method
fn <a href="#tymethod.format_time" class="fn">format_time</a>(&amp;self, w: &amp;mut <a class="struct" href="../format/struct.Writer.html" title="struct tracing_subscriber::fmt::format::Writer">Writer</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A type that can measure and format the current time.</p>
<p>This trait is used by <code>Format</code> to include a timestamp with each <code>Event</code> when it is logged.</p>
<p>Notable default implementations of this trait are <code>SystemTime</code> and <code>()</code>. The former prints the
current time as reported by <code>std::time::SystemTime</code>, and the latter does not print the current
time at all. <code>FormatTime</code> is also automatically implemented for any function pointer with the
appropriate signature.</p>
<p>The full list of provided implementations can be found in <a href="index.html" title="mod tracing_subscriber::fmt::time"><code>time</code></a>.</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.format_time" class="method"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#53">source</a><h4 class="code-header">fn <a href="#tymethod.format_time" class="fn">format_time</a>(&amp;self, w: &amp;mut <a class="struct" href="../format/struct.Writer.html" title="struct tracing_subscriber::fmt::format::Writer">Writer</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class="docblock"><p>Measure and write out the current time.</p>
<p>When <code>format_time</code> is called, implementors should get the current time using their desired
mechanism, and write it out to the given <code>fmt::Write</code>. Implementors must insert a trailing
space themselves if they wish to separate the time from subsequent log message text.</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-FormatTime-for-fn(%26mut+Writer%3C'b%3E)+-%3E+Result%3C(),+Error%3E" class="impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#104-108">source</a><a href="#impl-FormatTime-for-fn(%26mut+Writer%3C'b%3E)+-%3E+Result%3C(),+Error%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FormatTime.html" title="trait tracing_subscriber::fmt::time::FormatTime">FormatTime</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.fn.html">fn</a>(_: &amp;mut <a class="struct" href="../format/struct.Writer.html" title="struct tracing_subscriber::fmt::format::Writer">Writer</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h3></section></summary><div class="impl-items"><section id="method.format_time" class="method trait-impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#105-107">source</a><a href="#method.format_time" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.format_time" class="fn">format_time</a>(&amp;self, w: &amp;mut <a class="struct" href="../format/struct.Writer.html" title="struct tracing_subscriber::fmt::format::Writer">Writer</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-FormatTime-for-()" class="impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#98-102">source</a><a href="#impl-FormatTime-for-()" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FormatTime.html" title="trait tracing_subscriber::fmt::time::FormatTime">FormatTime</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a></h3></section></summary><div class="impl-items"><section id="method.format_time-1" class="method trait-impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#99-101">source</a><a href="#method.format_time-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.format_time" class="fn">format_time</a>(&amp;self, _: &amp;mut <a class="struct" href="../format/struct.Writer.html" title="struct tracing_subscriber::fmt::format::Writer">Writer</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-FormatTime-for-%26F" class="impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#89-96">source</a><a href="#impl-FormatTime-for-%26F" class="anchor">§</a><h3 class="code-header">impl&lt;'a, F&gt; <a class="trait" href="trait.FormatTime.html" title="trait tracing_subscriber::fmt::time::FormatTime">FormatTime</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.reference.html">&amp;'a F</a><div class="where">where
F: <a class="trait" href="trait.FormatTime.html" title="trait tracing_subscriber::fmt::time::FormatTime">FormatTime</a>,</div></h3></section></summary><div class="impl-items"><section id="method.format_time-2" class="method trait-impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#93-95">source</a><a href="#method.format_time-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.format_time" class="fn">format_time</a>(&amp;self, w: &amp;mut <a class="struct" href="../format/struct.Writer.html" title="struct tracing_subscriber::fmt::format::Writer">Writer</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-FormatTime-for-SystemTime" class="impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#136-144">source</a><a href="#impl-FormatTime-for-SystemTime" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FormatTime.html" title="trait tracing_subscriber::fmt::time::FormatTime">FormatTime</a> for <a class="struct" href="struct.SystemTime.html" title="struct tracing_subscriber::fmt::time::SystemTime">SystemTime</a></h3></section><section id="impl-FormatTime-for-Uptime" class="impl"><a class="src rightside" href="../../../src/tracing_subscriber/fmt/time/mod.rs.html#146-151">source</a><a href="#impl-FormatTime-for-Uptime" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.FormatTime.html" title="trait tracing_subscriber::fmt::time::FormatTime">FormatTime</a> for <a class="struct" href="struct.Uptime.html" title="struct tracing_subscriber::fmt::time::Uptime">Uptime</a></h3></section></div><script src="../../../trait.impl/tracing_subscriber/fmt/time/trait.FormatTime.js" data-ignore-extern-crates="std" async></script></section></div></main></body></html>