wasmer/rustdoc/ansi_term/enum.Color.html
2019-09-16 15:54:50 -07:00

92 lines
42 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 `Color` enum in crate `ansi_term`."><meta name="keywords" content="rust, rustlang, rust-lang, Color"><title>ansi_term::Color - 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 enum"><!--[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='../ansi_term/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Enum Color</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Black">Black</a><a href="#variant.Red">Red</a><a href="#variant.Green">Green</a><a href="#variant.Yellow">Yellow</a><a href="#variant.Blue">Blue</a><a href="#variant.Purple">Purple</a><a href="#variant.Cyan">Cyan</a><a href="#variant.White">White</a><a href="#variant.Fixed">Fixed</a><a href="#variant.RGB">RGB</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.blink">blink</a><a href="#method.bold">bold</a><a href="#method.dimmed">dimmed</a><a href="#method.hidden">hidden</a><a href="#method.infix">infix</a><a href="#method.italic">italic</a><a href="#method.normal">normal</a><a href="#method.on">on</a><a href="#method.paint">paint</a><a href="#method.prefix">prefix</a><a href="#method.reverse">reverse</a><a href="#method.strikethrough">strikethrough</a><a href="#method.suffix">suffix</a><a href="#method.underline">underline</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-From%3CColour%3E">From&lt;Colour&gt;</a><a href="#impl-PartialEq%3CColour%3E">PartialEq&lt;Colour&gt;</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow&lt;T&gt;</a><a href="#impl-BorrowMut%3CT%3E">BorrowMut&lt;T&gt;</a><a href="#impl-From%3CT%3E">From&lt;T&gt;</a><a href="#impl-Into%3CU%3E">Into&lt;U&gt;</a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom&lt;U&gt;</a><a href="#impl-TryInto%3CU%3E">TryInto&lt;U&gt;</a></div></div><p class='location'><a href='index.html'>ansi_term</a></p><script>window.sidebarCurrent = {name: 'Color', ty: 'enum', 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"><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/ansi_term/style.rs.html#137-189' title='goto source code'>[src]</a></span><span class='in-band'>Enum <a href='index.html'>ansi_term</a>::<wbr><a class="enum" href=''>Color</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust enum'>pub enum Color {
Black,
Red,
Green,
Yellow,
Blue,
Purple,
Cyan,
White,
Fixed(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>),
RGB(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>),
}</pre></div><div class='docblock'><p>A colour is one specific type of ANSI escape code, and can refer
to either the foreground or background colour.</p>
<p>These use the standard numeric sequences.
See <a href="http://invisible-island.net/xterm/ctlseqs/ctlseqs.html">http://invisible-island.net/xterm/ctlseqs/ctlseqs.html</a></p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.Black" class="variant small-section-header"><a href="#variant.Black" class="anchor field"></a><code id='Black.v'>Black</code></span><div class='docblock'><p>Colour #0 (foreground code <code>30</code>, background code <code>40</code>).</p>
<p>This is not necessarily the background colour, and using it as one may
render the text hard to read on terminals with dark backgrounds.</p>
</div><span id="variant.Red" class="variant small-section-header"><a href="#variant.Red" class="anchor field"></a><code id='Red.v'>Red</code></span><div class='docblock'><p>Colour #1 (foreground code <code>31</code>, background code <code>41</code>).</p>
</div><span id="variant.Green" class="variant small-section-header"><a href="#variant.Green" class="anchor field"></a><code id='Green.v'>Green</code></span><div class='docblock'><p>Colour #2 (foreground code <code>32</code>, background code <code>42</code>).</p>
</div><span id="variant.Yellow" class="variant small-section-header"><a href="#variant.Yellow" class="anchor field"></a><code id='Yellow.v'>Yellow</code></span><div class='docblock'><p>Colour #3 (foreground code <code>33</code>, background code <code>43</code>).</p>
</div><span id="variant.Blue" class="variant small-section-header"><a href="#variant.Blue" class="anchor field"></a><code id='Blue.v'>Blue</code></span><div class='docblock'><p>Colour #4 (foreground code <code>34</code>, background code <code>44</code>).</p>
</div><span id="variant.Purple" class="variant small-section-header"><a href="#variant.Purple" class="anchor field"></a><code id='Purple.v'>Purple</code></span><div class='docblock'><p>Colour #5 (foreground code <code>35</code>, background code <code>45</code>).</p>
</div><span id="variant.Cyan" class="variant small-section-header"><a href="#variant.Cyan" class="anchor field"></a><code id='Cyan.v'>Cyan</code></span><div class='docblock'><p>Colour #6 (foreground code <code>36</code>, background code <code>46</code>).</p>
</div><span id="variant.White" class="variant small-section-header"><a href="#variant.White" class="anchor field"></a><code id='White.v'>White</code></span><div class='docblock'><p>Colour #7 (foreground code <code>37</code>, background code <code>47</code>).</p>
<p>As above, this is not necessarily the foreground colour, and may be
hard to read on terminals with light backgrounds.</p>
</div><span id="variant.Fixed" class="variant small-section-header"><a href="#variant.Fixed" class="anchor field"></a><code id='Fixed.v'>Fixed(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></span><div class='docblock'><p>A colour number from 0 to 255, for use in 256-colour terminal
environments.</p>
<ul>
<li>Colours 0 to 7 are the <code>Black</code> to <code>White</code> variants respectively.
These colours can usually be changed in the terminal emulator.</li>
<li>Colours 8 to 15 are brighter versions of the eight colours above.
These can also usually be changed in the terminal emulator, or it
could be configured to use the original colours and show the text in
bold instead. It varies depending on the program.</li>
<li>Colours 16 to 231 contain several palettes of bright colours,
arranged in six squares measuring six by six each.</li>
<li>Colours 232 to 255 are shades of grey from black to white.</li>
</ul>
<p>It might make more sense to look at a <a href="https://upload.wikimedia.org/wikipedia/en/1/15/Xterm_256color_chart.svg">colour chart</a>.</p>
</div><span id="variant.RGB" class="variant small-section-header"><a href="#variant.RGB" class="anchor field"></a><code id='RGB.v'>RGB(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></span><div class='docblock'><p>A 24-bit RGB color, as specified by ISO-8613-3.</p>
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/ansi_term/ansi.rs.html#150-166' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.prefix' class="method"><code id='prefix.v'>pub fn <a href='#method.prefix' class='fnname'>prefix</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Prefix.html" title="struct ansi_term::Prefix">Prefix</a></code><a class='srclink' href='../src/ansi_term/ansi.rs.html#153-155' title='goto source code'>[src]</a></h4><div class='docblock'><p>The prefix for this colour.</p>
</div><h4 id='method.infix' class="method"><code id='infix.v'>pub fn <a href='#method.infix' class='fnname'>infix</a>(self, other: <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -&gt; <a class="struct" href="../ansi_term/struct.Infix.html" title="struct ansi_term::Infix">Infix</a></code><a class='srclink' href='../src/ansi_term/ansi.rs.html#158-160' title='goto source code'>[src]</a></h4><div class='docblock'><p>The infix between this colour and another.</p>
</div><h4 id='method.suffix' class="method"><code id='suffix.v'>pub fn <a href='#method.suffix' class='fnname'>suffix</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Suffix.html" title="struct ansi_term::Suffix">Suffix</a></code><a class='srclink' href='../src/ansi_term/ansi.rs.html#163-165' title='goto source code'>[src]</a></h4><div class='docblock'><p>The suffix for this colour.</p>
</div></div><h3 id='impl-1' class='impl'><code class='in-band'>impl <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-1' class='anchor'></a><a class='srclink' href='../src/ansi_term/style.rs.html#192-242' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.normal' class="method"><code id='normal.v'>pub fn <a href='#method.normal' class='fnname'>normal</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#194-196' title='goto source code'>[src]</a></h4><div class='docblock'><p>Return a <code>Style</code> with the foreground colour set to this colour.</p>
</div><h4 id='method.bold' class="method"><code id='bold.v'>pub fn <a href='#method.bold' class='fnname'>bold</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#199-201' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the bold property set.</p>
</div><h4 id='method.dimmed' class="method"><code id='dimmed.v'>pub fn <a href='#method.dimmed' class='fnname'>dimmed</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#204-206' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the dimmed property set.</p>
</div><h4 id='method.italic' class="method"><code id='italic.v'>pub fn <a href='#method.italic' class='fnname'>italic</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#209-211' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the italic property set.</p>
</div><h4 id='method.underline' class="method"><code id='underline.v'>pub fn <a href='#method.underline' class='fnname'>underline</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#214-216' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the underline property set.</p>
</div><h4 id='method.blink' class="method"><code id='blink.v'>pub fn <a href='#method.blink' class='fnname'>blink</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#219-221' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the blink property set.</p>
</div><h4 id='method.reverse' class="method"><code id='reverse.v'>pub fn <a href='#method.reverse' class='fnname'>reverse</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#224-226' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the reverse property set.</p>
</div><h4 id='method.hidden' class="method"><code id='hidden.v'>pub fn <a href='#method.hidden' class='fnname'>hidden</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#229-231' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the hidden property set.</p>
</div><h4 id='method.strikethrough' class="method"><code id='strikethrough.v'>pub fn <a href='#method.strikethrough' class='fnname'>strikethrough</a>(self) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#234-236' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the strikethrough property set.</p>
</div><h4 id='method.on' class="method"><code id='on.v'>pub fn <a href='#method.on' class='fnname'>on</a>(self, background: <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#239-241' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a <code>Style</code> with the background colour property set.</p>
</div></div><h3 id='impl-2' class='impl'><code class='in-band'>impl <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-2' class='anchor'></a><a class='srclink' href='../src/ansi_term/display.rs.html#159-177' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.paint' class="method"><code id='paint.v'>pub fn <a href='#method.paint' class='fnname'>paint</a>&lt;'a, I, S:&nbsp;'a + <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt;(<br>&nbsp;&nbsp;&nbsp;&nbsp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;input: I<br>) -&gt; <a class="struct" href="../ansi_term/struct.ANSIGenericString.html" title="struct ansi_term::ANSIGenericString">ANSIGenericString</a>&lt;'a, S&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, S&gt;&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;&lt;S as <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a>&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" title="type alloc::borrow::ToOwned::Owned">Owned</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,&nbsp;</span></code><a class='srclink' href='../src/ansi_term/display.rs.html#169-176' title='goto source code'>[src]</a></h4><div class='docblock'><p>Paints the given text with this colour, returning an ANSI string.
This is a short-cut so you dont have to use <code>Blue.normal()</code> just
to get blue text.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">ansi_term</span>::<span class="ident">Colour</span>::<span class="ident">Blue</span>;
<span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">Blue</span>.<span class="ident">paint</span>(<span class="string">&quot;da ba dee&quot;</span>));</pre></div>
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-PartialEq%3CColour%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a>&gt; for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-PartialEq%3CColour%3E' class='anchor'></a><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, other: &amp;<a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: &amp;<a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 id='impl-From%3CColour%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a>&gt; for <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a href='#impl-From%3CColour%3E' class='anchor'></a><a class='srclink' href='../src/ansi_term/style.rs.html#244-259' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(colour: <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -&gt; <a class="struct" href="../ansi_term/struct.Style.html" title="struct ansi_term::Style">Style</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#256-258' title='goto source code'>[src]</a></h4><div class='docblock'><p>You can turn a <code>Colour</code> into a <code>Style</code> with the foreground colour set
with the <code>From</code> trait.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">ansi_term</span>::{<span class="ident">Style</span>, <span class="ident">Colour</span>};
<span class="kw">let</span> <span class="ident">green_foreground</span> <span class="op">=</span> <span class="ident">Style</span>::<span class="ident">default</span>().<span class="ident">fg</span>(<span class="ident">Colour</span>::<span class="ident">Green</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">green_foreground</span>, <span class="ident">Colour</span>::<span class="ident">Green</span>.<span class="ident">normal</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">green_foreground</span>, <span class="ident">Colour</span>::<span class="ident">Green</span>.<span class="ident">into</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">green_foreground</span>, <span class="ident">Style</span>::<span class="ident">from</span>(<span class="ident">Colour</span>::<span class="ident">Green</span>));</pre></div>
</div></div><h3 id='impl-Copy' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-Copy' class='anchor'></a><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../src/ansi_term/style.rs.html#136' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="enum" href="../ansi_term/enum.Colour.html" title="enum ansi_term::Colour">Colour</a></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -&gt; U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#552-554' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from-1' class="method hidden"><code id='from.v-1'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -&gt; T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,&nbsp;</span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&amp;self) -&gt; T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></div></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 = "ansi_term";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>