47 lines
8.3 KiB
HTML
47 lines
8.3 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="Support for ANSI terminal colors via the colored crate."><meta name="keywords" content="rust, rustlang, rust-lang, colors"><title>fern::colors - 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="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../../fern/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Module colors</h2><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><div id="sidebar-vars" data-name="colors" data-ty="mod" 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="../../fern/index.html"><img class="rust-logo" src="../../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">fern</a>::<wbr><a class="mod" href="#">colors</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><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/fern/colors.rs.html#1-337" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Support for ANSI terminal colors via the colored crate.</p>
|
||
<p>To enable support for colors, add the <code>"colored"</code> feature in your
|
||
<code>Cargo.toml</code>:</p>
|
||
<div class="example-wrap"><pre class="language-toml"><code>[dependencies]
|
||
fern = { version = "0.5", features = ["colored"] }</code></pre></div>
|
||
<hr />
|
||
<p>Colors are mainly supported via coloring the log level itself, but it’s
|
||
also possible to color each entire log line based off of the log level.</p>
|
||
<p>First, here’s an example which colors the log levels themselves (“INFO” /
|
||
“WARN” text will have color, but won’t color the rest of the line).
|
||
<a href="struct.ColoredLevelConfig.html"><code>ColoredLevelConfig</code></a> lets us configure the colors per-level, but also has
|
||
sane defaults.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">fern::colors</span>::{<span class="ident">Color</span>, <span class="ident">ColoredLevelConfig</span>};
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">colors</span> <span class="op">=</span> <span class="ident">ColoredLevelConfig::new</span>()
|
||
<span class="comment">// use builder methods</span>
|
||
.<span class="ident">info</span>(<span class="ident">Color::Green</span>);
|
||
<span class="comment">// or access raw fields</span>
|
||
<span class="ident">colors</span>.<span class="ident">warn</span> <span class="op">=</span> <span class="ident">Color::Magenta</span>;</code></pre></div>
|
||
<p>It can then be used within any regular fern formatting closure:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="ident">fern::Dispatch::new</span>()
|
||
<span class="comment">// ...</span>
|
||
.<span class="ident">format</span>(<span class="kw">move</span> <span class="op">|</span><span class="ident">out</span>, <span class="ident">message</span>, <span class="ident">record</span><span class="op">|</span> {
|
||
<span class="ident">out</span>.<span class="ident">finish</span>(<span class="macro">format_args!</span>(
|
||
<span class="string">"[{}] {}"</span>,
|
||
<span class="comment">// just use 'colors.color(..)' instead of the level</span>
|
||
<span class="comment">// itself to insert ANSI colors.</span>
|
||
<span class="ident">colors</span>.<span class="ident">color</span>(<span class="ident">record</span>.<span class="ident">level</span>()),
|
||
<span class="ident">message</span>,
|
||
))
|
||
})</code></pre></div>
|
||
<hr />
|
||
<p>Coloring levels is nice, but the alternative is good to. For an example
|
||
application coloring each entire log line with the right color, see
|
||
<a href="https://github.com/daboross/fern/blob/master/examples/pretty-colored.rs">examples/pretty-colored.rs</a>.</p>
|
||
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ColoredLevelConfig.html" title="fern::colors::ColoredLevelConfig struct">ColoredLevelConfig</a></div><div class="item-right docblock-short"><p>Configuration specifying colors a log level can be colored as.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WithFgColor.html" title="fern::colors::WithFgColor struct">WithFgColor</a></div><div class="item-right docblock-short"><p>Opaque structure which represents some text data and a color to display it
|
||
with.</p>
|
||
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Color.html" title="fern::colors::Color enum">Color</a></div><div class="item-right docblock-short"><p>The 8 standard colors.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="fern" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |