218 lines
11 KiB
HTML
218 lines
11 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>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="http://www.rust-lang.org/favicon.ico">
|
|||
|
|
|
|||
|
|
</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'><img src='http://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></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 js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Module <a href='../index.html'>env_logger</a>::<wbr><a class="mod" href=''>fmt</a></span><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.rs.html#1-815' title='goto source code'>[src]</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>
|
|||
|
|
|
|||
|
|
<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">use</span> <span class="ident">env_logger</span>::<span class="ident">fmt</span>::<span class="ident">Color</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="kw">let</span> <span class="kw-2">mut</span> <span class="ident">level_style</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">style</span>();
|
|||
|
|
|
|||
|
|
<span class="ident">level_style</span>.<span class="ident">set_color</span>(<span class="ident">Color</span>::<span class="ident">Red</span>).<span class="ident">set_bold</span>(<span class="bool-val">true</span>);
|
|||
|
|
|
|||
|
|
<span class="macro">writeln</span><span class="macro">!</span>(<span class="ident">buf</span>, <span class="string">"{}: {}"</span>,
|
|||
|
|
<span class="ident">level_style</span>.<span class="ident">value</span>(<span class="ident">record</span>.<span class="ident">level</span>()),
|
|||
|
|
<span class="ident">record</span>.<span class="ident">args</span>())
|
|||
|
|
});</pre>
|
|||
|
|
</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='struct env_logger::fmt::Formatter'>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.ParseColorError.html"
|
|||
|
|
title='struct env_logger::fmt::ParseColorError'>ParseColorError</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An error from parsing an invalid color specification.</p>
|
|||
|
|
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Style.html"
|
|||
|
|
title='struct env_logger::fmt::Style'>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='struct env_logger::fmt::StyledValue'>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='struct env_logger::fmt::Timestamp'>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='enum env_logger::fmt::Color'>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='enum env_logger::fmt::Target'>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='enum env_logger::fmt::WriteStyle'>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>
|
|||
|
|
|
|||
|
|
<aside id="help" class="hidden">
|
|||
|
|
<div>
|
|||
|
|
<h1 class="hidden">Help</h1>
|
|||
|
|
|
|||
|
|
<div class="shortcuts">
|
|||
|
|
<h2>Keyboard Shortcuts</h2>
|
|||
|
|
|
|||
|
|
<dl>
|
|||
|
|
<dt><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse all sections</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<div class="infos">
|
|||
|
|
<h2>Search Tricks</h2>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Prefix searches with a type followed by a colon (e.g.
|
|||
|
|
<code>fn:</code>) to restrict the search to a given type.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Accepted types are: <code>fn</code>, <code>mod</code>,
|
|||
|
|
<code>struct</code>, <code>enum</code>,
|
|||
|
|
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
|||
|
|
and <code>const</code>.
|
|||
|
|
</p>
|
|||
|
|
|
|||
|
|
<p>
|
|||
|
|
Search functions by type signature (e.g.
|
|||
|
|
<code>vec -> usize</code> or <code>* -> vec</code>)
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../../";
|
|||
|
|
window.currentCrate = "env_logger";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|