<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A runtime-configurable text effect for use with `Style`"><title>Effect in owo_colors - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../"data-static-root-path="../static.files/"data-current-crate="owo_colors"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.1 (7cf61ebde 2024-03-27)"data-channel="1.77.1"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc enum"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button><aclass="logo-container"href="../owo_colors/index.html"><imgsrc="https://jam1.re/img/rust_owo.svg"alt=""></a></nav><navclass="sidebar"><divclass="sidebar-crate"><aclass="logo-container"href="../owo_colors/index.html"><imgsrc="https://jam1.re/img/rust_owo.svg"alt="logo"></a><h2><ahref="../owo_colors/index.html">owo_colors</a><spanclass="version">4.0.0</span></h2></div><h2class="location"><ahref="#">Effect</a></h2><divclass="sidebar-elems"><section><h3><ahref="#variants">Variants</a></h3><ulclass="block variant"><li><ahref="#variant.Blink">Blink</a></li><li><ahref="#variant.BlinkFast">BlinkFast</a></li><li><ahref="#variant.Bold">Bold</a></li><li><ahref="#variant.Dimmed">Dimmed</a></li><li><ahref="#variant.Hidden">Hidden</a></li><li><ahref="#variant.Italic">Italic</a></li><li><ahref="#variant.Reversed">Reversed</a></li><li><ahref="#variant.Strikethrough">Strikethrough</a></li><li><ahref="#variant.Underline">Underline</a></li></ul><h3><ahref="#trait-implementations">Trait Implementations</a></h3><ulclass="block trait-implementation"><li><ahref="#impl-Clone-for-Effect">Clone</a></li><li><ahref="#impl-Copy-for-Effect">Copy</a></li><li><ahref="#impl-Debug-for-Effect">Debug</a></li></ul><h3><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ulclass="block synthetic-implementation"><li><ahref="#impl-RefUnwindSafe-for-Effect">RefUnwindSafe</a></li><li><ahref="#impl-Send-for-Effect">Send</a></li><li><ahref="#impl-Sync-for-Effect">Sync</a></li><li><ahref="#impl-Unpin-for-Effect">Unpin</a></li><li><ahref="#impl-UnwindSafe-for-Effect">UnwindSafe</a></li></ul><h3><ahref="#blanket-implementations">Blanket Implementations</a></h3><ulclass="block blanket-implementation"><li><ahref="#impl-Any-for-T">Any</a></li><li><ahref="#impl-Borrow%3CT%3E-for-T">Borrow<T>
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../owo_colors/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Enum <ahref="index.html">owo_colors</a>::<wbr><aclass="enum"href="#">Effect</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../src/owo_colors/dyn_styles.rs.html#10-20">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub enum Effect {
Bold,
Dimmed,
Italic,
Underline,
Blink,
BlinkFast,
Reversed,
Hidden,
Strikethrough,
}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A runtime-configurable text effect for use with <ahref="struct.Style.html"title="struct owo_colors::Style"><code>Style</code></a></p>
<code><ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.From.html"title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-OwoColorize-for-D"class="impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#497">source</a><ahref="#impl-OwoColorize-for-D"class="anchor">§</a><h3class="code-header">impl<D><aclass="trait"href="trait.OwoColorize.html"title="trait owo_colors::OwoColorize">OwoColorize</a> for D</h3></section></summary><divclass="impl-items"><detailsclass="toggle method-toggle"open><summary><sectionid="method.fg"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#270-272">source</a><ahref="#method.fg"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.fg"class="fn">fg</a><C: <aclass="trait"href="trait.Color.html"title="trait owo_colors::Color">Color</a>>(&self) -><aclass="struct"href="struct.FgColorDisplay.html"title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, C, Self></h4></section></summary><divclass='docblock'>Set the foreground color generically <ahref="trait.OwoColorize.html#method.fg">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.bg"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#283-285">source</a><ahref="#method.bg"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.bg"class="fn">bg</a><C: <aclass="trait"href="trait.Color.html"title="trait owo_colors::Color">Color</a>>(&self) -><aclass="struct"href="struct.BgColorDisplay.html"title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, C, Self></h4></section></summary><divclass='docblock'>Set the background color generically. <ahref="trait.OwoColorize.html#method.bg">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.black"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#287-347">source</a><ahref="#method.black"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.black"class="fn">black</a>(&self) -><aclass="struct"href="struct.FgColorDisplay.html"title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <aclass="struct"href="colors/struct.Black.html"title="struct owo_colors::colors::Black">Black</a>, Self></h4></section></summary><divclass='docblock'>Change the foreground color to black</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.on_black"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#287-347">source</a><ahref="#method.on_black"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.on_black"class="fn">on_black</a>(&self) -><aclass="struct"href="struct.BgColorDisplay.html"title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <aclass="struct"href="colors/struct.Black.html"title="struct owo_colors::colors::Black">Black</a>, Self></h4></section></summary><divclass='docblock'>Change the background color to black</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.red"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#287-347">source</a><ahref="#method.red"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.red"class="fn">red</a>(&self) -><aclass="struct"href="struct.FgColorDisplay.html"title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <aclass="struct"href="colors/struct.Red.html"title="struct owo_colors::colors::Red">Red</a>, Self></h4></section></summary><divclass='docblock'>Change the foreground color to red</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.on_red"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#287-347">source</a><ahref="#method.on_red"
&self,
color: Color
) -><aclass="struct"href="struct.FgDynColorDisplay.html"title="struct owo_colors::FgDynColorDisplay">FgDynColorDisplay</a><'_, Color, Self></h4></section></summary><divclass='docblock'>Set the foreground color at runtime. Only use if you do not know which color will be used at
compile-time. If the color is constant, use either <ahref="trait.OwoColorize.html#method.fg"title="method owo_colors::OwoColorize::fg"><code>OwoColorize::fg</code></a> or
a color-specific method, such as <ahref="trait.OwoColorize.html#method.green"title="method owo_colors::OwoColorize::green"><code>OwoColorize::green</code></a>, <ahref="trait.OwoColorize.html#method.color">Read more</a></div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.on_color"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#396-398">source</a><ahref="#method.on_color"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.on_color"class="fn">on_color</a><Color: <aclass="trait"href="trait.DynColor.html"title="trait owo_colors::DynColor">DynColor</a>>(
&self,
color: Color
) -><aclass="struct"href="struct.BgDynColorDisplay.html"title="struct owo_colors::BgDynColorDisplay">BgDynColorDisplay</a><'_, Color, Self></h4></section></summary><divclass='docblock'>Set the background color at runtime. Only use if you do not know what color to use at
compile-time. If the color is constant, use either <ahref="trait.OwoColorize.html#method.bg"title="method owo_colors::OwoColorize::bg"><code>OwoColorize::bg</code></a> or
) -><aclass="struct"href="struct.BgColorDisplay.html"title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <aclass="struct"href="colors/struct.CustomColor.html"title="struct owo_colors::colors::CustomColor">CustomColor</a><R, G, B>, Self></h4></section></summary><divclass='docblock'>Set the background color to a specific RGB value.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.truecolor"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#419-421">source</a><ahref="#method.truecolor"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.truecolor"class="fn">truecolor</a>(&self, r: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/core/primitive.u8.html">u8</a>, g: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/core/primitive.u8.html">u8</a>, b: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/core/primitive.u8.html">u8</a>) -><aclass="struct"href="struct.FgDynColorDisplay.html"title="struct owo_colors::FgDynColorDisplay">FgDynColorDisplay</a><'_, <aclass="struct"href="struct.Rgb.html"title="struct owo_colors::Rgb">Rgb</a>, Self></h4></section></summary><divclass='docblock'>Sets the foreground color to an RGB value.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.on_truecolor"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#426-428">source</a><ahref="#method.on_truecolor"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.on_truecolor"class="fn">on_truecolor</a>(&self, r: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/core/primitive.u8.html">u8</a>, g: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/core/primitive.u8.html">u8</a>, b: <aclass="primitive"href="https://doc.rust-lang.org/1.77.1/core/primitive.u8.html">u8</a>) -><aclass="struct"href="struct.BgDynColorDisplay.html"title="struct owo_colors::BgDynColorDisplay">BgDynColorDisplay</a><'_, <aclass="struct"href="struct.Rgb.html"title="struct owo_colors::Rgb">Rgb</a>, Self></h4></section></summary><divclass='docblock'>Sets the background color to an RGB value.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.style"class="method trait-impl"><aclass="src rightside"href="../src/owo_colors/lib.rs.html#432-434">source</a><ahref="#method.style"class="anchor">§</a><h4class="code-header">fn <ahref="trait.OwoColorize.html#method.style"class="fn">style</a>(&self, style: <aclass="struct"href="struct.Style.html"title="struct owo_colors::Style">Style</a>) -><aclass="struct"href="struct.Styled.html"title="struct owo_colors::Styled">Styled</a><<aclass="primitive"href="https://doc.rust-lang.org/1.77.1/core/primitive.reference.html">&Self</a>></h4></section></summary><divclass='docblock'>Apply a runtime-determined style</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#804-806">source</a><ahref="#impl-TryFrom%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error-1"class="associatedtype trait-impl"><ahref="#associatedtype.Error-1"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#811">source</a><ahref="#method.try_from"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#tymethod.try_from"class="fn">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details><detailsclass="toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E-for-T"class="impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#789-791">source</a><ahref="#impl-TryInto%3CU%3E-for-T"class="anchor">§</a><h3class="code-header">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T<divclass="where">where
U: <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><divclass="impl-items"><detailsclass="toggle"open><summary><sectionid="associatedtype.Error"class="associatedtype trait-impl"><ahref="#associatedtype.Error"class="anchor">§</a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'>The type returned in the event of a conversion error.</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl"><aclass="src rightside"href="https://doc.rust-lang.org/1.77.1/src/core/convert/mod.rs.html#796">source</a><ahref="#method.try_into"class="anchor">§</a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryInto.html#tymethod.try_into"class="fn">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.77.1/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.77.1/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
