mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-09 09:38:24 +00:00
425 lines
100 KiB
HTML
425 lines
100 KiB
HTML
<!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="The attachment point of inline label arrows"><title>LabelAttach in ariadne - 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="ariadne" 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 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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../ariadne/index.html">ariadne</a><span class="version">0.4.1</span></h2></div><h2 class="location"><a href="#">LabelAttach</a></h2><div class="sidebar-elems"><section><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.End">End</a></li><li><a href="#variant.Middle">Middle</a></li><li><a href="#variant.Start">Start</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-LabelAttach">Clone</a></li><li><a href="#impl-Copy-for-LabelAttach">Copy</a></li><li><a href="#impl-Debug-for-LabelAttach">Debug</a></li><li><a href="#impl-Eq-for-LabelAttach">Eq</a></li><li><a href="#impl-PartialEq-for-LabelAttach">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-LabelAttach">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-LabelAttach">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-LabelAttach">RefUnwindSafe</a></li><li><a href="#impl-Send-for-LabelAttach">Send</a></li><li><a href="#impl-Sync-for-LabelAttach">Sync</a></li><li><a href="#impl-Unpin-for-LabelAttach">Unpin</a></li><li><a href="#impl-UnwindSafe-for-LabelAttach">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<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T">Into<U></a></li><li><a href="#impl-Paint-for-T">Paint</a></li><li><a href="#impl-ToOwned-for-T">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T">TryInto<U></a></li></ul></section><h2><a href="index.html">In crate ariadne</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>Enum <a href="index.html">ariadne</a>::<wbr><a class="enum" href="#">LabelAttach</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/ariadne/lib.rs.html#368-375">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub enum LabelAttach {
|
|
Start,
|
|
Middle,
|
|
End,
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The attachment point of inline label arrows</p>
|
|
</div></details><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.Start" class="variant"><a href="#variant.Start" class="anchor">§</a><h3 class="code-header">Start</h3></section><div class="docblock"><p>Arrows should attach to the start of the label span.</p>
|
|
</div><section id="variant.Middle" class="variant"><a href="#variant.Middle" class="anchor">§</a><h3 class="code-header">Middle</h3></section><div class="docblock"><p>Arrows should attach to the middle of the label span (or as close to the middle as we can get).</p>
|
|
</div><section id="variant.End" class="variant"><a href="#variant.End" class="anchor">§</a><h3 class="code-header">End</h3></section><div class="docblock"><p>Arrows should attach to the end of the label span.</p>
|
|
</div></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-LabelAttach" class="impl"><a class="src rightside" href="../src/ariadne/lib.rs.html#367">source</a><a href="#impl-Clone-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</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/ariadne/lib.rs.html#367">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>(&self) -> <a class="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</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>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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-LabelAttach" class="impl"><a class="src rightside" href="../src/ariadne/lib.rs.html#367">source</a><a href="#impl-Debug-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section></summary><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/ariadne/lib.rs.html#367">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>(&self, f: &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><'_>) -> <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-PartialEq-for-LabelAttach" class="impl"><a class="src rightside" href="../src/ariadne/lib.rs.html#367">source</a><a href="#impl-PartialEq-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</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/ariadne/lib.rs.html#367">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>(&self, other: &<a class="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a>) -> <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>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&Rhs</a>) -> <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-LabelAttach" class="impl"><a class="src rightside" href="../src/ariadne/lib.rs.html#367">source</a><a href="#impl-Copy-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section><section id="impl-Eq-for-LabelAttach" class="impl"><a class="src rightside" href="../src/ariadne/lib.rs.html#367">source</a><a href="#impl-Eq-for-LabelAttach" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section><section id="impl-StructuralPartialEq-for-LabelAttach" class="impl"><a class="src rightside" href="../src/ariadne/lib.rs.html#367">source</a><a href="#impl-StructuralPartialEq-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</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-LabelAttach" class="impl"><a href="#impl-Freeze-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section><section id="impl-RefUnwindSafe-for-LabelAttach" class="impl"><a href="#impl-RefUnwindSafe-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section><section id="impl-Send-for-LabelAttach" class="impl"><a href="#impl-Send-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section><section id="impl-Sync-for-LabelAttach" class="impl"><a href="#impl-Sync-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section><section id="impl-Unpin-for-LabelAttach" class="impl"><a href="#impl-Unpin-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</a></h3></section><section id="impl-UnwindSafe-for-LabelAttach" class="impl"><a href="#impl-UnwindSafe-for-LabelAttach" 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="enum" href="enum.LabelAttach.html" title="enum ariadne::LabelAttach">LabelAttach</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<T> <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>(&self) -> <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<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> 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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> 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>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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<T> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</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="https://doc.rust-lang.org/1.80.0/src/core/convert/mod.rs.html#768">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>(t: T) -> 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<T, 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><U> 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><T>,</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) -> 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><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Paint-for-T" class="impl"><a class="src rightside" href="../src/yansi/paint.rs.html#134">source</a><a href="#impl-Paint-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="../yansi/paint/trait.Paint.html" title="trait yansi::paint::Paint">Paint</a> 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.fg" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.fg" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.fg" class="fn">fg</a>(&self, value: <a class="enum" href="enum.Color.html" title="enum ariadne::Color">Color</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns a styled value derived from <code>self</code> with the foreground set to
|
|
<code>value</code>.</p>
|
|
<p>This method should be used rarely. Instead, prefer to use color-specific
|
|
builder methods like <a href="Self::red()"><code>red()</code></a> and
|
|
<a href="Self::green()"><code>green()</code></a>, which have the same functionality but are
|
|
pithier.</p>
|
|
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
|
<p>Set foreground color to white using <code>fg()</code>:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::{Paint, Color};
|
|
|
|
painted.fg(Color::White);</code></pre></div>
|
|
<p>Set foreground color to white using <a href="Self::white()"><code>white()</code></a>.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::Paint;
|
|
|
|
painted.white();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.primary" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.primary" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.primary" class="fn">primary</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Primary" title="variant ariadne::Color::Primary"><code>Color::Primary</code></a>.</p>
|
|
<h5 id="example-1"><a class="doc-anchor" href="#example-1">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.primary());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.fixed" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.fixed" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.fixed" class="fn">fixed</a>(&self, color: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Fixed" title="variant ariadne::Color::Fixed"><code>Color::Fixed</code></a>.</p>
|
|
<h5 id="example-2"><a class="doc-anchor" href="#example-2">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.fixed(color));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rgb" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.rgb" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.rgb" class="fn">rgb</a>(&self, r: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>, g: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>, b: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Rgb" title="variant ariadne::Color::Rgb"><code>Color::Rgb</code></a>.</p>
|
|
<h5 id="example-3"><a class="doc-anchor" href="#example-3">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.rgb(r, g, b));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.black" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.black" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.black" class="fn">black</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Black" title="variant ariadne::Color::Black"><code>Color::Black</code></a>.</p>
|
|
<h5 id="example-4"><a class="doc-anchor" href="#example-4">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.black());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.red" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.red" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.red" class="fn">red</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Red" title="variant ariadne::Color::Red"><code>Color::Red</code></a>.</p>
|
|
<h5 id="example-5"><a class="doc-anchor" href="#example-5">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.red());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.green" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.green" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.green" class="fn">green</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Green" title="variant ariadne::Color::Green"><code>Color::Green</code></a>.</p>
|
|
<h5 id="example-6"><a class="doc-anchor" href="#example-6">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.green());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.yellow" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.yellow" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.yellow" class="fn">yellow</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Yellow" title="variant ariadne::Color::Yellow"><code>Color::Yellow</code></a>.</p>
|
|
<h5 id="example-7"><a class="doc-anchor" href="#example-7">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.yellow());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.blue" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.blue" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.blue" class="fn">blue</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Blue" title="variant ariadne::Color::Blue"><code>Color::Blue</code></a>.</p>
|
|
<h5 id="example-8"><a class="doc-anchor" href="#example-8">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.blue());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.magenta" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.magenta" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.magenta" class="fn">magenta</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Magenta" title="variant ariadne::Color::Magenta"><code>Color::Magenta</code></a>.</p>
|
|
<h5 id="example-9"><a class="doc-anchor" href="#example-9">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.magenta());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.cyan" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.cyan" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.cyan" class="fn">cyan</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Cyan" title="variant ariadne::Color::Cyan"><code>Color::Cyan</code></a>.</p>
|
|
<h5 id="example-10"><a class="doc-anchor" href="#example-10">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.cyan());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.white" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.white" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.white" class="fn">white</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.White" title="variant ariadne::Color::White"><code>Color::White</code></a>.</p>
|
|
<h5 id="example-11"><a class="doc-anchor" href="#example-11">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.white());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_black" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_black" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_black" class="fn">bright_black</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightBlack" title="variant ariadne::Color::BrightBlack"><code>Color::BrightBlack</code></a>.</p>
|
|
<h5 id="example-12"><a class="doc-anchor" href="#example-12">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_black());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_red" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_red" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_red" class="fn">bright_red</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightRed" title="variant ariadne::Color::BrightRed"><code>Color::BrightRed</code></a>.</p>
|
|
<h5 id="example-13"><a class="doc-anchor" href="#example-13">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_red());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_green" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_green" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_green" class="fn">bright_green</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightGreen" title="variant ariadne::Color::BrightGreen"><code>Color::BrightGreen</code></a>.</p>
|
|
<h5 id="example-14"><a class="doc-anchor" href="#example-14">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_green());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_yellow" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_yellow" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_yellow" class="fn">bright_yellow</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightYellow" title="variant ariadne::Color::BrightYellow"><code>Color::BrightYellow</code></a>.</p>
|
|
<h5 id="example-15"><a class="doc-anchor" href="#example-15">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_yellow());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_blue" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_blue" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_blue" class="fn">bright_blue</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightBlue" title="variant ariadne::Color::BrightBlue"><code>Color::BrightBlue</code></a>.</p>
|
|
<h5 id="example-16"><a class="doc-anchor" href="#example-16">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_blue());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_magenta" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_magenta" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_magenta" class="fn">bright_magenta</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightMagenta" title="variant ariadne::Color::BrightMagenta"><code>Color::BrightMagenta</code></a>.</p>
|
|
<h5 id="example-17"><a class="doc-anchor" href="#example-17">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_magenta());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_cyan" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_cyan" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_cyan" class="fn">bright_cyan</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightCyan" title="variant ariadne::Color::BrightCyan"><code>Color::BrightCyan</code></a>.</p>
|
|
<h5 id="example-18"><a class="doc-anchor" href="#example-18">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_cyan());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_white" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright_white" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright_white" class="fn">bright_white</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::fg()"><code>fg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightWhite" title="variant ariadne::Color::BrightWhite"><code>Color::BrightWhite</code></a>.</p>
|
|
<h5 id="example-19"><a class="doc-anchor" href="#example-19">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright_white());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bg" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bg" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bg" class="fn">bg</a>(&self, value: <a class="enum" href="enum.Color.html" title="enum ariadne::Color">Color</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns a styled value derived from <code>self</code> with the background set to
|
|
<code>value</code>.</p>
|
|
<p>This method should be used rarely. Instead, prefer to use color-specific
|
|
builder methods like <a href="Self::on_red()"><code>on_red()</code></a> and
|
|
<a href="Self::on_green()"><code>on_green()</code></a>, which have the same functionality but
|
|
are pithier.</p>
|
|
<h5 id="example-20"><a class="doc-anchor" href="#example-20">§</a>Example</h5>
|
|
<p>Set background color to red using <code>fg()</code>:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::{Paint, Color};
|
|
|
|
painted.bg(Color::Red);</code></pre></div>
|
|
<p>Set background color to red using <a href="Self::on_red()"><code>on_red()</code></a>.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::Paint;
|
|
|
|
painted.on_red();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_primary" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_primary" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_primary" class="fn">on_primary</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Primary" title="variant ariadne::Color::Primary"><code>Color::Primary</code></a>.</p>
|
|
<h5 id="example-21"><a class="doc-anchor" href="#example-21">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_primary());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_fixed" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_fixed" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_fixed" class="fn">on_fixed</a>(&self, color: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Fixed" title="variant ariadne::Color::Fixed"><code>Color::Fixed</code></a>.</p>
|
|
<h5 id="example-22"><a class="doc-anchor" href="#example-22">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_fixed(color));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_rgb" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_rgb" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_rgb" class="fn">on_rgb</a>(&self, r: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>, g: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>, b: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Rgb" title="variant ariadne::Color::Rgb"><code>Color::Rgb</code></a>.</p>
|
|
<h5 id="example-23"><a class="doc-anchor" href="#example-23">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_rgb(r, g, b));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_black" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_black" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_black" class="fn">on_black</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Black" title="variant ariadne::Color::Black"><code>Color::Black</code></a>.</p>
|
|
<h5 id="example-24"><a class="doc-anchor" href="#example-24">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_black());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_red" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_red" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_red" class="fn">on_red</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Red" title="variant ariadne::Color::Red"><code>Color::Red</code></a>.</p>
|
|
<h5 id="example-25"><a class="doc-anchor" href="#example-25">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_red());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_green" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_green" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_green" class="fn">on_green</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Green" title="variant ariadne::Color::Green"><code>Color::Green</code></a>.</p>
|
|
<h5 id="example-26"><a class="doc-anchor" href="#example-26">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_green());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_yellow" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_yellow" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_yellow" class="fn">on_yellow</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Yellow" title="variant ariadne::Color::Yellow"><code>Color::Yellow</code></a>.</p>
|
|
<h5 id="example-27"><a class="doc-anchor" href="#example-27">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_yellow());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_blue" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_blue" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_blue" class="fn">on_blue</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Blue" title="variant ariadne::Color::Blue"><code>Color::Blue</code></a>.</p>
|
|
<h5 id="example-28"><a class="doc-anchor" href="#example-28">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_blue());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_magenta" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_magenta" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_magenta" class="fn">on_magenta</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Magenta" title="variant ariadne::Color::Magenta"><code>Color::Magenta</code></a>.</p>
|
|
<h5 id="example-29"><a class="doc-anchor" href="#example-29">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_magenta());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_cyan" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_cyan" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_cyan" class="fn">on_cyan</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.Cyan" title="variant ariadne::Color::Cyan"><code>Color::Cyan</code></a>.</p>
|
|
<h5 id="example-30"><a class="doc-anchor" href="#example-30">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_cyan());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_white" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_white" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_white" class="fn">on_white</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.White" title="variant ariadne::Color::White"><code>Color::White</code></a>.</p>
|
|
<h5 id="example-31"><a class="doc-anchor" href="#example-31">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_white());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_black" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_black" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_black" class="fn">on_bright_black</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightBlack" title="variant ariadne::Color::BrightBlack"><code>Color::BrightBlack</code></a>.</p>
|
|
<h5 id="example-32"><a class="doc-anchor" href="#example-32">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_black());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_red" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_red" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_red" class="fn">on_bright_red</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightRed" title="variant ariadne::Color::BrightRed"><code>Color::BrightRed</code></a>.</p>
|
|
<h5 id="example-33"><a class="doc-anchor" href="#example-33">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_red());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_green" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_green" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_green" class="fn">on_bright_green</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightGreen" title="variant ariadne::Color::BrightGreen"><code>Color::BrightGreen</code></a>.</p>
|
|
<h5 id="example-34"><a class="doc-anchor" href="#example-34">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_green());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_yellow" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_yellow" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_yellow" class="fn">on_bright_yellow</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightYellow" title="variant ariadne::Color::BrightYellow"><code>Color::BrightYellow</code></a>.</p>
|
|
<h5 id="example-35"><a class="doc-anchor" href="#example-35">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_yellow());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_blue" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_blue" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_blue" class="fn">on_bright_blue</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightBlue" title="variant ariadne::Color::BrightBlue"><code>Color::BrightBlue</code></a>.</p>
|
|
<h5 id="example-36"><a class="doc-anchor" href="#example-36">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_blue());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_magenta" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_magenta" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_magenta" class="fn">on_bright_magenta</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightMagenta" title="variant ariadne::Color::BrightMagenta"><code>Color::BrightMagenta</code></a>.</p>
|
|
<h5 id="example-37"><a class="doc-anchor" href="#example-37">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_magenta());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_cyan" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_cyan" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_cyan" class="fn">on_bright_cyan</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightCyan" title="variant ariadne::Color::BrightCyan"><code>Color::BrightCyan</code></a>.</p>
|
|
<h5 id="example-38"><a class="doc-anchor" href="#example-38">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_cyan());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_white" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright_white" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright_white" class="fn">on_bright_white</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::bg()"><code>bg()</code></a>
|
|
set to
|
|
<a href="enum.Color.html#variant.BrightWhite" title="variant ariadne::Color::BrightWhite"><code>Color::BrightWhite</code></a>.</p>
|
|
<h5 id="example-39"><a class="doc-anchor" href="#example-39">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright_white());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.attr" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.attr" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.attr" class="fn">attr</a>(&self, value: <a class="enum" href="../yansi/attr_quirk/enum.Attribute.html" title="enum yansi::attr_quirk::Attribute">Attribute</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Enables the styling <a href="../yansi/attr_quirk/enum.Attribute.html" title="enum yansi::attr_quirk::Attribute"><code>Attribute</code></a> <code>value</code>.</p>
|
|
<p>This method should be used rarely. Instead, prefer to use
|
|
attribute-specific builder methods like <a href="Self::bold()"><code>bold()</code></a> and
|
|
<a href="Self::underline()"><code>underline()</code></a>, which have the same functionality
|
|
but are pithier.</p>
|
|
<h5 id="example-40"><a class="doc-anchor" href="#example-40">§</a>Example</h5>
|
|
<p>Make text bold using <code>attr()</code>:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::{Paint, Attribute};
|
|
|
|
painted.attr(Attribute::Bold);</code></pre></div>
|
|
<p>Make text bold using using <a href="Self::bold()"><code>bold()</code></a>.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::Paint;
|
|
|
|
painted.bold();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bold" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bold" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bold" class="fn">bold</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Bold" title="variant yansi::attr_quirk::Attribute::Bold"><code>Attribute::Bold</code></a>.</p>
|
|
<h5 id="example-41"><a class="doc-anchor" href="#example-41">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bold());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.dim" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.dim" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.dim" class="fn">dim</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Dim" title="variant yansi::attr_quirk::Attribute::Dim"><code>Attribute::Dim</code></a>.</p>
|
|
<h5 id="example-42"><a class="doc-anchor" href="#example-42">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.dim());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.italic" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.italic" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.italic" class="fn">italic</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Italic" title="variant yansi::attr_quirk::Attribute::Italic"><code>Attribute::Italic</code></a>.</p>
|
|
<h5 id="example-43"><a class="doc-anchor" href="#example-43">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.italic());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.underline" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.underline" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.underline" class="fn">underline</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Underline" title="variant yansi::attr_quirk::Attribute::Underline"><code>Attribute::Underline</code></a>.</p>
|
|
<h5 id="example-44"><a class="doc-anchor" href="#example-44">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.underline());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.blink" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.blink" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.blink" class="fn">blink</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Blink" title="variant yansi::attr_quirk::Attribute::Blink"><code>Attribute::Blink</code></a>.</p>
|
|
<h5 id="example-45"><a class="doc-anchor" href="#example-45">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.blink());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.rapid_blink" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.rapid_blink" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.rapid_blink" class="fn">rapid_blink</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.RapidBlink" title="variant yansi::attr_quirk::Attribute::RapidBlink"><code>Attribute::RapidBlink</code></a>.</p>
|
|
<h5 id="example-46"><a class="doc-anchor" href="#example-46">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.rapid_blink());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.invert" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.invert" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.invert" class="fn">invert</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Invert" title="variant yansi::attr_quirk::Attribute::Invert"><code>Attribute::Invert</code></a>.</p>
|
|
<h5 id="example-47"><a class="doc-anchor" href="#example-47">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.invert());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.conceal" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.conceal" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.conceal" class="fn">conceal</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Conceal" title="variant yansi::attr_quirk::Attribute::Conceal"><code>Attribute::Conceal</code></a>.</p>
|
|
<h5 id="example-48"><a class="doc-anchor" href="#example-48">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.conceal());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.strike" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.strike" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.strike" class="fn">strike</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::attr()"><code>attr()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Attribute.html#variant.Strike" title="variant yansi::attr_quirk::Attribute::Strike"><code>Attribute::Strike</code></a>.</p>
|
|
<h5 id="example-49"><a class="doc-anchor" href="#example-49">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.strike());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.quirk" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.quirk" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.quirk" class="fn">quirk</a>(&self, value: <a class="enum" href="../yansi/attr_quirk/enum.Quirk.html" title="enum yansi::attr_quirk::Quirk">Quirk</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Enables the <code>yansi</code> <a href="../yansi/attr_quirk/enum.Quirk.html" title="enum yansi::attr_quirk::Quirk"><code>Quirk</code></a> <code>value</code>.</p>
|
|
<p>This method should be used rarely. Instead, prefer to use quirk-specific
|
|
builder methods like <a href="Self::mask()"><code>mask()</code></a> and
|
|
<a href="Self::wrap()"><code>wrap()</code></a>, which have the same functionality but are
|
|
pithier.</p>
|
|
<h5 id="example-50"><a class="doc-anchor" href="#example-50">§</a>Example</h5>
|
|
<p>Enable wrapping using <code>.quirk()</code>:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::{Paint, Quirk};
|
|
|
|
painted.quirk(Quirk::Wrap);</code></pre></div>
|
|
<p>Enable wrapping using <a href="Self::wrap()"><code>wrap()</code></a>.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::Paint;
|
|
|
|
painted.wrap();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.mask" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.mask" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.mask" class="fn">mask</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::quirk()"><code>quirk()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Quirk.html#variant.Mask" title="variant yansi::attr_quirk::Quirk::Mask"><code>Quirk::Mask</code></a>.</p>
|
|
<h5 id="example-51"><a class="doc-anchor" href="#example-51">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.mask());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.wrap" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.wrap" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.wrap" class="fn">wrap</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::quirk()"><code>quirk()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Quirk.html#variant.Wrap" title="variant yansi::attr_quirk::Quirk::Wrap"><code>Quirk::Wrap</code></a>.</p>
|
|
<h5 id="example-52"><a class="doc-anchor" href="#example-52">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.wrap());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.linger" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.linger" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.linger" class="fn">linger</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::quirk()"><code>quirk()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Quirk.html#variant.Linger" title="variant yansi::attr_quirk::Quirk::Linger"><code>Quirk::Linger</code></a>.</p>
|
|
<h5 id="example-53"><a class="doc-anchor" href="#example-53">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.linger());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.clear" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.clear" class="fn">clear</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 1.0.1: renamed to <code>resetting()</code> due to conflicts with <code>Vec::clear()</code>.
|
|
The <code>clear()</code> method will be removed in a future release.</span></div></span></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::quirk()"><code>quirk()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Quirk.html#variant.Clear" title="variant yansi::attr_quirk::Quirk::Clear"><code>Quirk::Clear</code></a>.</p>
|
|
<h5 id="example-54"><a class="doc-anchor" href="#example-54">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.clear());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.resetting" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.resetting" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.resetting" class="fn">resetting</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::quirk()"><code>quirk()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Quirk.html#variant.Resetting" title="variant yansi::attr_quirk::Quirk::Resetting"><code>Quirk::Resetting</code></a>.</p>
|
|
<h5 id="example-55"><a class="doc-anchor" href="#example-55">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.resetting());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.bright" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.bright" class="fn">bright</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::quirk()"><code>quirk()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Quirk.html#variant.Bright" title="variant yansi::attr_quirk::Quirk::Bright"><code>Quirk::Bright</code></a>.</p>
|
|
<h5 id="example-56"><a class="doc-anchor" href="#example-56">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.bright());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.on_bright" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.on_bright" class="fn">on_bright</a>(&self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Returns <code>self</code> with the
|
|
<a href="Self::quirk()"><code>quirk()</code></a>
|
|
set to
|
|
<a href="../yansi/attr_quirk/enum.Quirk.html#variant.OnBright" title="variant yansi::attr_quirk::Quirk::OnBright"><code>Quirk::OnBright</code></a>.</p>
|
|
<h5 id="example-57"><a class="doc-anchor" href="#example-57">§</a>Example</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">println!</span>(<span class="string">"{}"</span>, value.on_bright());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.whenever" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#135">source</a><a href="#method.whenever" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#tymethod.whenever" class="fn">whenever</a>(&self, value: <a class="struct" href="../yansi/condition/struct.Condition.html" title="struct yansi::condition::Condition">Condition</a>) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>></h4></section></summary><div class="docblock"><p>Conditionally enable styling based on whether the <a href="../yansi/condition/struct.Condition.html" title="struct yansi::condition::Condition"><code>Condition</code></a> <code>value</code>
|
|
applies. Replaces any previous condition.</p>
|
|
<p>See the <a href="../yansi/index.html#per-style" title="mod yansi">crate level docs</a> for more details.</p>
|
|
<h5 id="example-58"><a class="doc-anchor" href="#example-58">§</a>Example</h5>
|
|
<p>Enable styling <code>painted</code> only when both <code>stdout</code> and <code>stderr</code> are TTYs:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>yansi::{Paint, Condition};
|
|
|
|
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.new" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#104">source</a><a href="#method.new" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#method.new" class="fn">new</a>(self) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><Self><div class="where">where
|
|
Self: <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></h4></section></summary><div class='docblock'>Create a new <a href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted"><code>Painted</code></a> with a default <a href="../yansi/style/struct.Style.html" title="struct yansi::style::Style"><code>Style</code></a>. <a href="../yansi/paint/trait.Paint.html#method.new">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.paint" class="method trait-impl"><a class="src rightside" href="../src/yansi/paint.rs.html#126">source</a><a href="#method.paint" class="anchor">§</a><h4 class="code-header">fn <a href="../yansi/paint/trait.Paint.html#method.paint" class="fn">paint</a><S>(&self, style: S) -> <a class="struct" href="../yansi/paint/struct.Painted.html" title="struct yansi::paint::Painted">Painted</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&Self</a>><div class="where">where
|
|
S: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../yansi/style/struct.Style.html" title="struct yansi::style::Style">Style</a>>,</div></h4></section></summary><div class='docblock'>Apply a style wholesale to <code>self</code>. Any previous style is replaced. <a href="../yansi/paint/trait.Paint.html#method.paint">Read more</a></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<T> <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>(&self) -> 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>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&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<T, 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><U> 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><T>,</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) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <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><U>>::<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'>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<T, U> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> 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><T>,</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> = <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><T>>::<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) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <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><T>>::<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'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |