| <!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="A colour is one specific type of ANSI escape code, and can refer to either the foreground or background colour."><meta name="keywords" content="rust, rustlang, rust-lang, Colour"><title>Colour in ansi_term - 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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.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 enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../ansi_term/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../ansi_term/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Colour</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block"><li><a href="#variant.Black">Black</a></li><li><a href="#variant.Blue">Blue</a></li><li><a href="#variant.Cyan">Cyan</a></li><li><a href="#variant.Fixed">Fixed</a></li><li><a href="#variant.Green">Green</a></li><li><a href="#variant.Purple">Purple</a></li><li><a href="#variant.RGB">RGB</a></li><li><a href="#variant.Red">Red</a></li><li><a href="#variant.White">White</a></li><li><a href="#variant.Yellow">Yellow</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.blink">blink</a></li><li><a href="#method.bold">bold</a></li><li><a href="#method.dimmed">dimmed</a></li><li><a href="#method.hidden">hidden</a></li><li><a href="#method.infix">infix</a></li><li><a href="#method.italic">italic</a></li><li><a href="#method.normal">normal</a></li><li><a href="#method.on">on</a></li><li><a href="#method.paint">paint</a></li><li><a href="#method.prefix">prefix</a></li><li><a href="#method.reverse">reverse</a></li><li><a href="#method.strikethrough">strikethrough</a></li><li><a href="#method.suffix">suffix</a></li><li><a href="#method.underline">underline</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Colour">Clone</a></li><li><a href="#impl-Copy-for-Colour">Copy</a></li><li><a href="#impl-Debug-for-Colour">Debug</a></li><li><a href="#impl-From%3CColour%3E-for-Style">From<Colour></a></li><li><a href="#impl-PartialEq%3CColour%3E-for-Colour">PartialEq<Colour></a></li><li><a href="#impl-StructuralPartialEq-for-Colour">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Colour">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Colour">Send</a></li><li><a href="#impl-Sync-for-Colour">Sync</a></li><li><a href="#impl-Unpin-for-Colour">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Colour">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Colour">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Colour">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Colour">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Colour">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Colour">Into<U></a></li><li><a href="#impl-ToOwned-for-Colour">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Colour">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Colour">TryInto<U></a></li></ul></section><h2><a href="index.html">In ansi_term</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Enum <a href="index.html">ansi_term</a>::<wbr><a class="enum" href="#">Colour</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></h1><span class="out-of-band"><a class="srclink" href="../src/ansi_term/style.rs.html#256-308">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust enum"><code>pub enum Colour { |
| 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>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>), |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="variants" class="variants small-section-header">Variants<a href="#variants" class="anchor"></a></h2><h3 id="variant.Black" class="variant small-section-header"><a href="#variant.Black" class="anchor field"></a><code>Black</code></h3><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><h3 id="variant.Red" class="variant small-section-header"><a href="#variant.Red" class="anchor field"></a><code>Red</code></h3><div class="docblock"><p>Colour #1 (foreground code <code>31</code>, background code <code>41</code>).</p> |
| </div><h3 id="variant.Green" class="variant small-section-header"><a href="#variant.Green" class="anchor field"></a><code>Green</code></h3><div class="docblock"><p>Colour #2 (foreground code <code>32</code>, background code <code>42</code>).</p> |
| </div><h3 id="variant.Yellow" class="variant small-section-header"><a href="#variant.Yellow" class="anchor field"></a><code>Yellow</code></h3><div class="docblock"><p>Colour #3 (foreground code <code>33</code>, background code <code>43</code>).</p> |
| </div><h3 id="variant.Blue" class="variant small-section-header"><a href="#variant.Blue" class="anchor field"></a><code>Blue</code></h3><div class="docblock"><p>Colour #4 (foreground code <code>34</code>, background code <code>44</code>).</p> |
| </div><h3 id="variant.Purple" class="variant small-section-header"><a href="#variant.Purple" class="anchor field"></a><code>Purple</code></h3><div class="docblock"><p>Colour #5 (foreground code <code>35</code>, background code <code>45</code>).</p> |
| </div><h3 id="variant.Cyan" class="variant small-section-header"><a href="#variant.Cyan" class="anchor field"></a><code>Cyan</code></h3><div class="docblock"><p>Colour #6 (foreground code <code>36</code>, background code <code>46</code>).</p> |
| </div><h3 id="variant.White" class="variant small-section-header"><a href="#variant.White" class="anchor field"></a><code>White</code></h3><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><h3 id="variant.Fixed" class="variant small-section-header"><a href="#variant.Fixed" class="anchor field"></a><code>Fixed(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></h3><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/commons/1/15/Xterm_256color_chart.svg">colour chart</a>.</p> |
| </div><h3 id="variant.RGB" class="variant small-section-header"><a href="#variant.RGB" class="anchor field"></a><code>RGB(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></h3><div class="docblock"><p>A 24-bit RGB color, as specified by ISO-8613-3.</p> |
| </div><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Colour" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/ansi.rs.html#221-274">source</a><a href="#impl-Colour" class="anchor"></a><h3 class="code-header">impl <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.prefix" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/ansi.rs.html#236-238">source</a><h4 class="code-header">pub fn <a href="#method.prefix" class="fnname">prefix</a>(self) -> <a class="struct" href="struct.Prefix.html" title="struct ansi_term::Prefix">Prefix</a></h4></section></summary><div class="docblock"><p>The prefix bytes for this colour as a <code>Style</code>. These are the bytes |
| that tell the terminal to use a different colour or font style.</p> |
| <p>See also <a href="struct.Style.html#method.prefix"><code>Style::prefix</code></a>.</p> |
| <h5 id="examples"><a href="#examples">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour::Green; |
| |
| <span class="macro">assert_eq!</span>(<span class="string">"\x1b[0m"</span>, |
| Green.suffix().to_string());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.infix" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/ansi.rs.html#254-256">source</a><h4 class="code-header">pub fn <a href="#method.infix" class="fnname">infix</a>(self, next: <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -> <a class="struct" href="struct.Infix.html" title="struct ansi_term::Infix">Infix</a></h4></section></summary><div class="docblock"><p>The infix bytes between this colour and <code>next</code> colour. These are the bytes |
| that tell the terminal to use the <code>next</code> colour, or to do nothing if |
| the two colours are equal.</p> |
| <p>See also <a href="struct.Style.html#method.infix"><code>Style::infix</code></a>.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour::{Red, Yellow}; |
| |
| <span class="macro">assert_eq!</span>(<span class="string">"\x1b[33m"</span>, |
| Red.infix(Yellow).to_string());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.suffix" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/ansi.rs.html#271-273">source</a><h4 class="code-header">pub fn <a href="#method.suffix" class="fnname">suffix</a>(self) -> <a class="struct" href="struct.Suffix.html" title="struct ansi_term::Suffix">Suffix</a></h4></section></summary><div class="docblock"><p>The suffix for this colour as a <code>Style</code>. These are the bytes that |
| tell the terminal to reset back to its normal colour and font style.</p> |
| <p>See also <a href="struct.Style.html#method.suffix"><code>Style::suffix</code></a>.</p> |
| <h5 id="examples-2"><a href="#examples-2">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour::Purple; |
| |
| <span class="macro">assert_eq!</span>(<span class="string">"\x1b[0m"</span>, |
| Purple.suffix().to_string());</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Colour-1" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#311-461">source</a><a href="#impl-Colour-1" class="anchor"></a><h3 class="code-header">impl <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.normal" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#323-325">source</a><h4 class="code-header">pub fn <a href="#method.normal" class="fnname">normal</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour.</p> |
| <h5 id="examples-3"><a href="#examples-3">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Red.normal(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"hi"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bold" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#338-340">source</a><h4 class="code-header">pub fn <a href="#method.bold" class="fnname">bold</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| bold property set.</p> |
| <h5 id="examples-4"><a href="#examples-4">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Green.bold(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"hey"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.dimmed" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#353-355">source</a><h4 class="code-header">pub fn <a href="#method.dimmed" class="fnname">dimmed</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| dimmed property set.</p> |
| <h5 id="examples-5"><a href="#examples-5">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Yellow.dimmed(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"sup"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.italic" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#368-370">source</a><h4 class="code-header">pub fn <a href="#method.italic" class="fnname">italic</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| italic property set.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Blue.italic(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"greetings"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.underline" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#383-385">source</a><h4 class="code-header">pub fn <a href="#method.underline" class="fnname">underline</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| underline property set.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Purple.underline(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"salutations"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.blink" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#398-400">source</a><h4 class="code-header">pub fn <a href="#method.blink" class="fnname">blink</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| blink property set.</p> |
| <h5 id="examples-8"><a href="#examples-8">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Cyan.blink(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"wazzup"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.reverse" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#413-415">source</a><h4 class="code-header">pub fn <a href="#method.reverse" class="fnname">reverse</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| reverse property set.</p> |
| <h5 id="examples-9"><a href="#examples-9">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Black.reverse(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"aloha"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.hidden" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#428-430">source</a><h4 class="code-header">pub fn <a href="#method.hidden" class="fnname">hidden</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| hidden property set.</p> |
| <h5 id="examples-10"><a href="#examples-10">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::White.hidden(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"ahoy"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.strikethrough" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#443-445">source</a><h4 class="code-header">pub fn <a href="#method.strikethrough" class="fnname">strikethrough</a>(self) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| strikethrough property set.</p> |
| <h5 id="examples-11"><a href="#examples-11">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::Fixed(<span class="number">244</span>).strikethrough(); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"yo"</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.on" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#458-460">source</a><h4 class="code-header">pub fn <a href="#method.on" class="fnname">on</a>(self, background: <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground colour set to this colour and the |
| background colour property set to the given colour.</p> |
| <h5 id="examples-12"><a href="#examples-12">Examples</a></h5> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour; |
| |
| <span class="kw">let </span>style = Colour::RGB(<span class="number">31</span>, <span class="number">31</span>, <span class="number">31</span>).on(Colour::White); |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"eyyyy"</span>));</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Colour-2" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/display.rs.html#175-194">source</a><a href="#impl-Colour-2" class="anchor"></a><h3 class="code-header">impl <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.paint" class="method has-srclink"><a class="srclink rightside" href="../src/ansi_term/display.rs.html#186-193">source</a><h4 class="code-header">pub fn <a href="#method.paint" class="fnname">paint</a><'a, I, S: '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>>(<br> self,<br> input: I<br>) -> <a class="struct" href="struct.ANSIGenericString.html" title="struct ansi_term::ANSIGenericString">ANSIGenericString</a><'a, S><span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="https://doc.rust-lang.org/nightly/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a><'a, S>>,<br> <S as <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a>>::<a class="associatedtype" 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>,</span></h4></section></summary><div class="docblock"><p>Paints the given text with this colour, returning an ANSI string. |
| This is a short-cut so you don’t have to use <code>Blue.normal()</code> just |
| to get blue text.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>ansi_term::Colour::Blue; |
| <span class="macro">println!</span>(<span class="string">"{}"</span>, Blue.paint(<span class="string">"da ba dee"</span>));</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#impl-Clone-for-Colour" class="anchor"></a><h3 class="code-header">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="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone" class="fnname">clone</a>(&self) -> <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><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#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from" class="fnname">clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#impl-Debug-for-Colour" class="anchor"></a><h3 class="code-header">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="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-From%3CColour%3E-for-Style" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#463-478">source</a><a href="#impl-From%3CColour%3E-for-Style" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a>> for <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#475-477">source</a><a href="#method.from" class="anchor"></a><h4 class="code-header">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="enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -> <a class="struct" href="struct.Style.html" title="struct ansi_term::Style">Style</a></h4></section></summary><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"><code><span class="kw">use </span>ansi_term::{Style, Colour}; |
| <span class="kw">let </span>green_foreground = Style::default().fg(Colour::Green); |
| <span class="macro">assert_eq!</span>(green_foreground, Colour::Green.normal()); |
| <span class="macro">assert_eq!</span>(green_foreground, Colour::Green.into()); |
| <span class="macro">assert_eq!</span>(green_foreground, Style::from(Colour::Green));</code></pre></div> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CColour%3E-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#impl-PartialEq%3CColour%3E-for-Colour" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a>> for <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#method.eq" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq" class="fnname">eq</a>(&self, other: &<a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>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></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl has-srclink"><span class="rightside"><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/cmp.rs.html#227">source</a></span><a href="#method.ne" class="anchor"></a><h4 class="code-header">const fn <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne" class="fnname">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always |
| sufficient, and should not be overridden without very good reason. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne">Read more</a></div></details></div></details><section id="impl-Copy-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#impl-Copy-for-Colour" class="anchor"></a><h3 class="code-header">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="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section><section id="impl-StructuralPartialEq-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="../src/ansi_term/style.rs.html#254">source</a><a href="#impl-StructuralPartialEq-for-Colour" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></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"><section id="impl-RefUnwindSafe-for-Colour" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Colour" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section><section id="impl-Send-for-Colour" class="impl has-srclink"><a href="#impl-Send-for-Colour" class="anchor"></a><h3 class="code-header">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="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section><section id="impl-Sync-for-Colour" class="impl has-srclink"><a href="#impl-Sync-for-Colour" class="anchor"></a><h3 class="code-header">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="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section><section id="impl-Unpin-for-Colour" class="impl has-srclink"><a href="#impl-Unpin-for-Colour" class="anchor"></a><h3 class="code-header">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="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section><section id="impl-UnwindSafe-for-Colour" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Colour" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="enum" href="enum.Colour.html" title="enum ansi_term::Colour">Colour</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-Colour" class="anchor"></a><h3 class="code-header">impl<T> <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> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-Colour" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-Colour" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-Colour" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from-1" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-Colour" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#83">source</a><a href="#impl-ToOwned-for-Colour" class="anchor"></a><h3 class="code-header">impl<T> <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> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>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></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fnname">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-Colour" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Colour" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-Colour" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="ansi_term" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |