33 lines
9.2 KiB
HTML
33 lines
9.2 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="Coloring terminal so simple, you already know how to do it !"><meta name="keywords" content="rust, rustlang, rust-lang, colored"><title>colored - 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 crate"><!--[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="../colored/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Crate colored</h2><div class="block version"><div class="narrow-helper"></div><p>Version 1.9.3</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all colored's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><div id="sidebar-vars" data-name="colored" 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="../colored/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">Crate <a class="mod" href="#">colored</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/colored/lib.rs.html#1-813" 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>Coloring terminal so simple, you already know how to do it !</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">colored::Colorize</span>;
|
||
|
||
<span class="string">"this is blue"</span>.<span class="ident">blue</span>();
|
||
<span class="string">"this is red"</span>.<span class="ident">red</span>();
|
||
<span class="string">"this is red on blue"</span>.<span class="ident">red</span>().<span class="ident">on_blue</span>();
|
||
<span class="string">"this is also red on blue"</span>.<span class="ident">on_blue</span>().<span class="ident">red</span>();
|
||
<span class="string">"you can also make bold comments"</span>.<span class="ident">bold</span>();
|
||
<span class="macro">println!</span>(<span class="string">"{} {} {}"</span>, <span class="string">"or use"</span>.<span class="ident">cyan</span>(), <span class="string">"any"</span>.<span class="ident">italic</span>().<span class="ident">yellow</span>(), <span class="string">"string type"</span>.<span class="ident">cyan</span>());
|
||
<span class="string">"or change advice. This is red"</span>.<span class="ident">yellow</span>().<span class="ident">blue</span>().<span class="ident">red</span>();
|
||
<span class="string">"or clear things up. This is default color and style"</span>.<span class="ident">red</span>().<span class="ident">bold</span>().<span class="ident">clear</span>();
|
||
<span class="string">"purple and magenta are the same"</span>.<span class="ident">purple</span>().<span class="ident">magenta</span>();
|
||
<span class="string">"bright colors are also allowed"</span>.<span class="ident">bright_blue</span>().<span class="ident">on_bright_white</span>();
|
||
<span class="string">"you can specify color by string"</span>.<span class="ident">color</span>(<span class="string">"blue"</span>).<span class="ident">on_color</span>(<span class="string">"red"</span>);
|
||
<span class="string">"and so are normal and clear"</span>.<span class="ident">normal</span>().<span class="ident">clear</span>();
|
||
<span class="ident">String::from</span>(<span class="string">"this also works!"</span>).<span class="ident">green</span>().<span class="ident">bold</span>();
|
||
<span class="macro">format!</span>(<span class="string">"{:30}"</span>, <span class="string">"format works as expected. This will be padded"</span>.<span class="ident">blue</span>());
|
||
<span class="macro">format!</span>(<span class="string">"{:.3}"</span>, <span class="string">"and this will be green but truncated to 3 chars"</span>.<span class="ident">green</span>());</code></pre></div>
|
||
<p>See <a href="./trait.Colorize.html">the <code>Colorize</code> trait</a> for all the methods.</p>
|
||
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="control/index.html" title="colored::control mod">control</a></div><div class="item-right docblock-short"><p>A couple of functions to enable and disable coloring.</p>
|
||
</div></div></div><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.ColoredString.html" title="colored::ColoredString struct">ColoredString</a></div><div class="item-right docblock-short"><p>A string that may have color and/or style applied to it.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Style.html" title="colored::Style struct">Style</a></div><div class="item-right docblock-short"><p>A combinatorial style such as bold, italics, dimmed, etc.</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="colored::Color enum">Color</a></div><div class="item-right docblock-short"><p>The 8 standard colors.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Styles.html" title="colored::Styles enum">Styles</a></div><div class="item-right docblock-short"></div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Colorize.html" title="colored::Colorize trait">Colorize</a></div><div class="item-right docblock-short"><p>The trait that enables something to be given color.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="colored" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |