wasmer/rustdoc/colored/index.html
2019-09-06 15:57:44 -07:00

30 lines
8.2 KiB
HTML
Raw Permalink 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="API documentation for the Rust `colored` crate."><meta name="keywords" content="rust, rustlang, rust-lang, colored"><title>colored - 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="../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">&#9776;</div><a href='../colored/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate colored</p><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><p class='location'></p><script>window.sidebarCurrent = {name: 'colored', ty: 'mod', relpath: '../'};</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"><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><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'>&#x2212;</span>]</a></span><a class='srclink' href='../src/colored/lib.rs.html#1-687' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>colored</a></span></h1><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">
<span class="kw">use</span> <span class="ident">colored</span>::<span class="ident">Colorize</span>;
<span class="string">&quot;this is blue&quot;</span>.<span class="ident">blue</span>();
<span class="string">&quot;this is red&quot;</span>.<span class="ident">red</span>();
<span class="string">&quot;this is red on blue&quot;</span>.<span class="ident">red</span>().<span class="ident">on_blue</span>();
<span class="string">&quot;this is also red on blue&quot;</span>.<span class="ident">on_blue</span>().<span class="ident">red</span>();
<span class="string">&quot;you can also make bold comments&quot;</span>.<span class="ident">bold</span>();
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{} {} {}&quot;</span>, <span class="string">&quot;or use&quot;</span>.<span class="ident">cyan</span>(), <span class="string">&quot;any&quot;</span>.<span class="ident">italic</span>().<span class="ident">yellow</span>(), <span class="string">&quot;string type&quot;</span>.<span class="ident">cyan</span>());
<span class="string">&quot;or change advice. This is red&quot;</span>.<span class="ident">yellow</span>().<span class="ident">blue</span>().<span class="ident">red</span>();
<span class="string">&quot;or clear things up. This is default color and style&quot;</span>.<span class="ident">red</span>().<span class="ident">bold</span>().<span class="ident">clear</span>();
<span class="string">&quot;purple and magenta are the same&quot;</span>.<span class="ident">purple</span>().<span class="ident">magenta</span>();
<span class="string">&quot;bright colors are also allowed&quot;</span>.<span class="ident">bright_blue</span>().<span class="ident">on_bright_white</span>();
<span class="string">&quot;you can specify color by string&quot;</span>.<span class="ident">color</span>(<span class="string">&quot;blue&quot;</span>).<span class="ident">on_color</span>(<span class="string">&quot;red&quot;</span>);
<span class="string">&quot;and so are normal and clear&quot;</span>.<span class="ident">normal</span>().<span class="ident">clear</span>();
<span class="ident">String</span>::<span class="ident">from</span>(<span class="string">&quot;this also works!&quot;</span>).<span class="ident">green</span>().<span class="ident">bold</span>();
<span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{:30}&quot;</span>, <span class="string">&quot;format works as expected. This will be padded&quot;</span>.<span class="ident">blue</span>());
<span class="macro">format</span><span class="macro">!</span>(<span class="string">&quot;{:.3}&quot;</span>, <span class="string">&quot;and this will be green but truncated to 3 chars&quot;</span>.<span class="ident">green</span>());</pre></div>
<p>See <a href="./trait.Colorize.html">the <code>Colorize</code> trait</a> for all the methods.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="control/index.html" title='colored::control mod'>control</a></td><td class='docblock-short'><p>A couple of functions to enable and disable coloring.</p>
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.ColoredString.html" title='colored::ColoredString struct'>ColoredString</a></td><td class='docblock-short'><p>A string that may have color and/or style applied to it.</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='colored::Color enum'>Color</a></td><td class='docblock-short'><p>The 8 standard colors.</p>
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.Colorize.html" title='colored::Colorize trait'>Colorize</a></td><td class='docblock-short'><p>The trait that enables something to be given color.</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>&#9166;</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "colored";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>