edlang/nu_ansi_term/struct.Style.html
2024-07-26 09:42:18 +00:00

194 lines
56 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="A style is a collection of properties that can format a string using ANSI escape codes."><title>Style in nu_ansi_term - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="nu_ansi_term" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../nu_ansi_term/index.html">nu_ansi_term</a><span class="version">0.46.0</span></h2></div><h2 class="location"><a href="#">Style</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.background">background</a></li><li><a href="#structfield.foreground">foreground</a></li><li><a href="#structfield.is_blink">is_blink</a></li><li><a href="#structfield.is_bold">is_bold</a></li><li><a href="#structfield.is_dimmed">is_dimmed</a></li><li><a href="#structfield.is_hidden">is_hidden</a></li><li><a href="#structfield.is_italic">is_italic</a></li><li><a href="#structfield.is_reverse">is_reverse</a></li><li><a href="#structfield.is_strikethrough">is_strikethrough</a></li><li><a href="#structfield.is_underline">is_underline</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><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.fg">fg</a></li><li><a href="#method.hidden">hidden</a></li><li><a href="#method.infix">infix</a></li><li><a href="#method.is_plain">is_plain</a></li><li><a href="#method.italic">italic</a></li><li><a href="#method.new">new</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 trait-implementation"><li><a href="#impl-Clone-for-Style">Clone</a></li><li><a href="#impl-Copy-for-Style">Copy</a></li><li><a href="#impl-Debug-for-Style">Debug</a></li><li><a href="#impl-Default-for-Style">Default</a></li><li><a href="#impl-From%3CColor%3E-for-Style">From&lt;Color&gt;</a></li><li><a href="#impl-PartialEq-for-Style">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-Style">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Style">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Style">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Style">Send</a></li><li><a href="#impl-Sync-for-Style">Sync</a></li><li><a href="#impl-Unpin-for-Style">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Style">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T">Borrow&lt;T&gt;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut&lt;T&gt;</a></li><li><a href="#impl-From%3CT%3E-for-T">From&lt;T&gt;</a></li><li><a href="#impl-Into%3CU%3E-for-T">Into&lt;U&gt;</a></li><li><a href="#impl-ToOwned-for-T">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom&lt;U&gt;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto&lt;U&gt;</a></li></ul></section><h2><a href="index.html">In crate nu_ansi_term</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">nu_ansi_term</a>::<wbr><a class="struct" href="#">Style</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/nu_ansi_term/style.rs.html#17-47">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub struct Style {
pub foreground: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>&gt;,
pub background: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>&gt;,
pub is_bold: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
pub is_dimmed: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
pub is_italic: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
pub is_underline: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
pub is_blink: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
pub is_reverse: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
pub is_hidden: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
pub is_strikethrough: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a>,
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A style is a collection of properties that can format a string
using ANSI escape codes.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::{Style, Color};
<span class="kw">let </span>style = Style::new().bold().on(Color::Black);
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"Bold on black"</span>));</code></pre></div>
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.foreground" class="structfield section-header"><a href="#structfield.foreground" class="anchor field">§</a><code>foreground: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>&gt;</code></span><div class="docblock"><p>The styles foreground color, if it has one.</p>
</div><span id="structfield.background" class="structfield section-header"><a href="#structfield.background" class="anchor field">§</a><code>background: <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>&gt;</code></span><div class="docblock"><p>The styles background color, if it has one.</p>
</div><span id="structfield.is_bold" class="structfield section-header"><a href="#structfield.is_bold" class="anchor field">§</a><code>is_bold: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style is bold.</p>
</div><span id="structfield.is_dimmed" class="structfield section-header"><a href="#structfield.is_dimmed" class="anchor field">§</a><code>is_dimmed: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style is dimmed.</p>
</div><span id="structfield.is_italic" class="structfield section-header"><a href="#structfield.is_italic" class="anchor field">§</a><code>is_italic: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style is italic.</p>
</div><span id="structfield.is_underline" class="structfield section-header"><a href="#structfield.is_underline" class="anchor field">§</a><code>is_underline: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style is underlined.</p>
</div><span id="structfield.is_blink" class="structfield section-header"><a href="#structfield.is_blink" class="anchor field">§</a><code>is_blink: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style is blinking.</p>
</div><span id="structfield.is_reverse" class="structfield section-header"><a href="#structfield.is_reverse" class="anchor field">§</a><code>is_reverse: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style has reverse colors.</p>
</div><span id="structfield.is_hidden" class="structfield section-header"><a href="#structfield.is_hidden" class="anchor field">§</a><code>is_hidden: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style is hidden.</p>
</div><span id="structfield.is_strikethrough" class="structfield section-header"><a href="#structfield.is_strikethrough" class="anchor field">§</a><code>is_strikethrough: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></code></span><div class="docblock"><p>Whether this style is struckthrough.</p>
</div><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/ansi.rs.html#176-249">source</a><a href="#impl-Style" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.prefix" class="method"><a class="src rightside" href="../src/nu_ansi_term/ansi.rs.html#197-199">source</a><h4 class="code-header">pub fn <a href="#method.prefix" class="fn">prefix</a>(self) -&gt; <a class="struct" href="ansi/struct.Prefix.html" title="struct nu_ansi_term::ansi::Prefix">Prefix</a></h4></section></summary><div class="docblock"><p>The prefix bytes for this style. These are the bytes that tell the
terminal to use a different color or font style.</p>
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::{Style, Color::Blue};
<span class="kw">let </span>style = Style::default().bold();
<span class="macro">assert_eq!</span>(<span class="string">"\x1b[1m"</span>,
style.prefix().to_string());
<span class="kw">let </span>style = Blue.bold();
<span class="macro">assert_eq!</span>(<span class="string">"\x1b[1;34m"</span>,
style.prefix().to_string());
<span class="kw">let </span>style = Style::default();
<span class="macro">assert_eq!</span>(<span class="string">""</span>,
style.prefix().to_string());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.infix" class="method"><a class="src rightside" href="../src/nu_ansi_term/ansi.rs.html#222-224">source</a><h4 class="code-header">pub fn <a href="#method.infix" class="fn">infix</a>(self, next: <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a>) -&gt; <a class="struct" href="ansi/struct.Infix.html" title="struct nu_ansi_term::ansi::Infix">Infix</a></h4></section></summary><div class="docblock"><p>The infix bytes between this style and <code>next</code> style. These are the bytes
that tell the terminal to change the style to <code>next</code>. These may include
a reset followed by the next color and style, depending on the two styles.</p>
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::{Style, Color::Green};
<span class="kw">let </span>style = Style::default().bold();
<span class="macro">assert_eq!</span>(<span class="string">"\x1b[32m"</span>,
style.infix(Green.bold()).to_string());
<span class="kw">let </span>style = Green.normal();
<span class="macro">assert_eq!</span>(<span class="string">"\x1b[1m"</span>,
style.infix(Green.bold()).to_string());
<span class="kw">let </span>style = Style::default();
<span class="macro">assert_eq!</span>(<span class="string">""</span>,
style.infix(style).to_string());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.suffix" class="method"><a class="src rightside" href="../src/nu_ansi_term/ansi.rs.html#246-248">source</a><h4 class="code-header">pub fn <a href="#method.suffix" class="fn">suffix</a>(self) -&gt; <a class="struct" href="ansi/struct.Suffix.html" title="struct nu_ansi_term::ansi::Suffix">Suffix</a></h4></section></summary><div class="docblock"><p>The suffix for this style. These are the bytes that tell the terminal
to reset back to its normal color and font style.</p>
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::{Style, Color::Green};
<span class="kw">let </span>style = Style::default().bold();
<span class="macro">assert_eq!</span>(<span class="string">"\x1b[0m"</span>,
style.suffix().to_string());
<span class="kw">let </span>style = Green.normal().bold();
<span class="macro">assert_eq!</span>(<span class="string">"\x1b[0m"</span>,
style.suffix().to_string());
<span class="kw">let </span>style = Style::default();
<span class="macro">assert_eq!</span>(<span class="string">""</span>,
style.suffix().to_string());</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Style-1" class="impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#49-247">source</a><a href="#impl-Style-1" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#60-62">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Creates a new Style with no properties set.</p>
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"hi"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.bold" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#74-79">source</a><h4 class="code-header">pub fn <a href="#method.bold" class="fn">bold</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the bold property set.</p>
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().bold();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"hey"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.dimmed" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#91-96">source</a><h4 class="code-header">pub fn <a href="#method.dimmed" class="fn">dimmed</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the dimmed property set.</p>
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().dimmed();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"sup"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.italic" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#108-113">source</a><h4 class="code-header">pub fn <a href="#method.italic" class="fn">italic</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the italic property set.</p>
<h5 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().italic();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"greetings"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.underline" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#125-130">source</a><h4 class="code-header">pub fn <a href="#method.underline" class="fn">underline</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the underline property set.</p>
<h5 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().underline();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"salutations"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.blink" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#141-146">source</a><h4 class="code-header">pub fn <a href="#method.blink" class="fn">blink</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the blink property set.</p>
<h5 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().blink();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"wazzup"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.reverse" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#158-163">source</a><h4 class="code-header">pub fn <a href="#method.reverse" class="fn">reverse</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the reverse property set.</p>
<h5 id="examples-10"><a class="doc-anchor" href="#examples-10">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().reverse();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"aloha"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.hidden" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#175-180">source</a><h4 class="code-header">pub fn <a href="#method.hidden" class="fn">hidden</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the hidden property set.</p>
<h5 id="examples-11"><a class="doc-anchor" href="#examples-11">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().hidden();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"ahoy"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.strikethrough" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#192-197">source</a><h4 class="code-header">pub fn <a href="#method.strikethrough" class="fn">strikethrough</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the strikethrough property set.</p>
<h5 id="examples-12"><a class="doc-anchor" href="#examples-12">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="kw">let </span>style = Style::new().strikethrough();
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"yo"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.fg" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#209-214">source</a><h4 class="code-header">pub fn <a href="#method.fg" class="fn">fg</a>(&amp;self, foreground: <a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the foreground color property set.</p>
<h5 id="examples-13"><a class="doc-anchor" href="#examples-13">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::{Style, Color};
<span class="kw">let </span>style = Style::new().fg(Color::Yellow);
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"hi"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.on" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#226-231">source</a><h4 class="code-header">pub fn <a href="#method.on" class="fn">on</a>(&amp;self, background: <a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a <code>Style</code> with the background color property set.</p>
<h5 id="examples-14"><a class="doc-anchor" href="#examples-14">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::{Style, Color};
<span class="kw">let </span>style = Style::new().on(Color::Blue);
<span class="macro">println!</span>(<span class="string">"{}"</span>, style.paint(<span class="string">"eyyyy"</span>));</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_plain" class="method"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#244-246">source</a><h4 class="code-header">pub fn <a href="#method.is_plain" class="fn">is_plain</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return true if this <code>Style</code> has no actual styles, and can be written
without any control characters.</p>
<h5 id="examples-15"><a class="doc-anchor" href="#examples-15">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="macro">assert_eq!</span>(<span class="bool-val">true</span>, Style::default().is_plain());
<span class="macro">assert_eq!</span>(<span class="bool-val">false</span>, Style::default().bold().is_plain());</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Style-2" class="impl"><a class="src rightside" href="../src/nu_ansi_term/display.rs.html#150-163">source</a><a href="#impl-Style-2" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.paint" class="method"><a class="src rightside" href="../src/nu_ansi_term/display.rs.html#153-162">source</a><h4 class="code-header">pub fn <a href="#method.paint" class="fn">paint</a>&lt;'a, I, S: 'a + <a class="trait" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt;(
self,
input: I,
) -&gt; <a class="struct" href="struct.AnsiGenericString.html" title="struct nu_ansi_term::AnsiGenericString">AnsiGenericString</a>&lt;'a, S&gt;<div class="where">where
I: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/enum.Cow.html" title="enum alloc::borrow::Cow">Cow</a>&lt;'a, S&gt;&gt;,
&lt;S as <a class="trait" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a>&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" title="type alloc::borrow::ToOwned::Owned">Owned</a>: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></h4></section></summary><div class="docblock"><p>Paints the given text with this color, returning an ANSI string.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#12">source</a><a href="#impl-Clone-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#12">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.80.0/src/core/clone.rs.html#169">source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Self</a>)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/debug.rs.html#13-89">source</a><a href="#impl-Debug-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="docblock"><p>Styles have a special <code>Debug</code> implementation that only shows the fields that
are set. Fields that havent been touched arent included in the output.</p>
<p>This behaviour gets bypassed when using the alternate formatting mode
<code>format!(&quot;{:#?}&quot;)</code>.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Color::{Red, Blue};
<span class="macro">assert_eq!</span>(<span class="string">"Style { fg(Red), on(Blue), bold, italic }"</span>,
<span class="macro">format!</span>(<span class="string">"{:?}"</span>, Red.on(Blue).bold().italic()));</code></pre></div>
</div><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/nu_ansi_term/debug.rs.html#14-88">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, fmt: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.80.0/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/1.80.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#249-274">source</a><a href="#impl-Default-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#260-273">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>Returns a style with <em>no</em> properties set. Formatting text using this
style returns the exact same text.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::Style;
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, Style::default().foreground);
<span class="macro">assert_eq!</span>(<span class="prelude-val">None</span>, Style::default().background);
<span class="macro">assert_eq!</span>(<span class="bool-val">false</span>, Style::default().is_bold);
<span class="macro">assert_eq!</span>(<span class="string">"txt"</span>, Style::default().paint(<span class="string">"txt"</span>).to_string());</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CColor%3E-for-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#570-584">source</a><a href="#impl-From%3CColor%3E-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>&gt; for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#581-583">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(color: <a class="enum" href="enum.Color.html" title="enum nu_ansi_term::Color">Color</a>) -&gt; <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h4></section></summary><div class="docblock"><p>You can turn a <code>Color</code> into a <code>Style</code> with the foreground color set
with the <code>From</code> trait.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>nu_ansi_term::{Style, Color};
<span class="kw">let </span>green_foreground = Style::default().fg(Color::Green);
<span class="macro">assert_eq!</span>(green_foreground, Color::Green.normal());
<span class="macro">assert_eq!</span>(green_foreground, Color::Green.into());
<span class="macro">assert_eq!</span>(green_foreground, Style::from(Color::Green));</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#12">source</a><a href="#impl-PartialEq-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#12">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&amp;self, other: &amp;<a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/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>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.80.0/src/core/cmp.rs.html#263">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;Rhs</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/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.</div></details></div></details><section id="impl-Copy-for-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#12">source</a><a href="#impl-Copy-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section><section id="impl-StructuralPartialEq-for-Style" class="impl"><a class="src rightside" href="../src/nu_ansi_term/style.rs.html#12">source</a><a href="#impl-StructuralPartialEq-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-Style" class="impl"><a href="#impl-Freeze-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section><section id="impl-RefUnwindSafe-for-Style" class="impl"><a href="#impl-RefUnwindSafe-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section><section id="impl-Send-for-Style" class="impl"><a href="#impl-Send-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section><section id="impl-Sync-for-Style" class="impl"><a href="#impl-Sync-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section><section id="impl-Unpin-for-Style" class="impl"><a href="#impl-Unpin-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section><section id="impl-UnwindSafe-for-Style" class="impl"><a href="#impl-UnwindSafe-for-Style" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.Style.html" title="struct nu_ansi_term::Style">Style</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#140">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/any.rs.html#141">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.80.0/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/1.80.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#208">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#210">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#216">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/borrow.rs.html#217">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; 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/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/alloc/borrow.rs.html#83-85">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/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="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/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/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/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/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&amp;mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.80.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.80.0/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="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/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/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/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="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.80.0/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/1.80.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>