32 lines
6.9 KiB
HTML
32 lines
6.9 KiB
HTML
<!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 `fmt` mod in crate `env_logger`."><meta name="keywords" content="rust, rustlang, rust-lang, fmt"><title>env_logger::fmt - 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="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/static/images/favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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='../../env_logger/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'>Module fmt</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>env_logger</a></p><script>window.sidebarCurrent = {name: 'fmt', ty: 'mod', 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><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/env_logger/fmt/mod.rs.html#1-358' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>env_logger</a>::<wbr><a class="mod" href=''>fmt</a></span></h1><div class='docblock'><p>Formatting for log records.</p>
|
||
<p>This module contains a <a href="struct.Formatter.html"><code>Formatter</code></a> that can be used to format log records
|
||
into without needing temporary allocations. Usually you won't need to worry
|
||
about the contents of this module and can use the <code>Formatter</code> like an ordinary
|
||
<a href="https://doc.rust-lang.org/stable/std/io/trait.Write.html"><code>Write</code></a>.</p>
|
||
<h1 id="formatting-log-records" class="section-header"><a href="#formatting-log-records">Formatting log records</a></h1>
|
||
<p>The format used to print log records can be customised using the <a href="../struct.Builder.html#method.format"><code>Builder::format</code></a>
|
||
method.
|
||
Custom formats can apply different color and weight to printed values using
|
||
<a href="struct.Style.html"><code>Style</code></a> builders.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Write</span>;
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">builder</span> <span class="op">=</span> <span class="ident">env_logger</span>::<span class="ident">Builder</span>::<span class="ident">new</span>();
|
||
|
||
<span class="ident">builder</span>.<span class="ident">format</span>(<span class="op">|</span><span class="ident">buf</span>, <span class="ident">record</span><span class="op">|</span> {
|
||
<span class="macro">writeln</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="string">"{}: {}"</span>,
|
||
<span class="ident">record</span>.<span class="ident">level</span>(),
|
||
<span class="ident">record</span>.<span class="ident">args</span>())
|
||
});</pre></div>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table><tr class='module-item'><td><a class="struct" href="struct.Formatter.html" title='env_logger::fmt::Formatter struct'>Formatter</a></td><td class='docblock-short'><p>A formatter to write logs into.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.PreciseTimestamp.html" title='env_logger::fmt::PreciseTimestamp struct'>PreciseTimestamp</a></td><td class='docblock-short'><p>An <a href="https://www.ietf.org/rfc/rfc3339.txt">RFC3339</a> formatted timestamp with nanos.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Style.html" title='env_logger::fmt::Style struct'>Style</a></td><td class='docblock-short'><p>A set of styles to apply to the terminal output.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.StyledValue.html" title='env_logger::fmt::StyledValue struct'>StyledValue</a></td><td class='docblock-short'><p>A value that can be printed using the given styles.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Timestamp.html" title='env_logger::fmt::Timestamp struct'>Timestamp</a></td><td class='docblock-short'><p>An <a href="https://www.ietf.org/rfc/rfc3339.txt">RFC3339</a> formatted timestamp.</p>
|
||
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
||
<table><tr class='module-item'><td><a class="enum" href="enum.Color.html" title='env_logger::fmt::Color enum'>Color</a></td><td class='docblock-short'><p>The set of available colors for the terminal foreground/background.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Target.html" title='env_logger::fmt::Target enum'>Target</a></td><td class='docblock-short'><p>Log target, either <code>stdout</code> or <code>stderr</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.WriteStyle.html" title='env_logger::fmt::WriteStyle enum'>WriteStyle</a></td><td class='docblock-short'><p>Whether or not to print styles to the target.</p>
|
||
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "env_logger";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |