mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-10 01:58:23 +00:00
17 lines
15 KiB
HTML
17 lines
15 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="A trait describing a runtime-configurable color which can displayed using `FgDynColorDisplay` or `BgDynColorDisplay`. If your color will be known at compile time it is recommended you avoid this."><title>DynColor in owo_colors - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="owo_colors" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><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 trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="logo-container" href="../owo_colors/index.html"><img src="https://jam1.re/img/rust_owo.svg" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../owo_colors/index.html"><img src="https://jam1.re/img/rust_owo.svg" alt="logo"></a><h2><a href="../owo_colors/index.html">owo_colors</a><span class="version">4.0.0</span></h2></div><h2 class="location"><a href="#">DynColor</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.fmt_ansi_bg">fmt_ansi_bg</a></li><li><a href="#tymethod.fmt_ansi_fg">fmt_ansi_fg</a></li><li><a href="#tymethod.fmt_raw_ansi_bg">fmt_raw_ansi_bg</a></li><li><a href="#tymethod.fmt_raw_ansi_fg">fmt_raw_ansi_fg</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-DynColor-for-str">str</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate owo_colors</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../owo_colors/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="index.html">owo_colors</a>::<wbr><a class="trait" href="#">DynColor</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/owo_colors/lib.rs.html#127-145">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait DynColor {
|
||
// Required methods
|
||
fn <a href="#tymethod.fmt_ansi_fg" class="fn">fmt_ansi_fg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.fmt_ansi_bg" class="fn">fmt_ansi_bg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.fmt_raw_ansi_fg" class="fn">fmt_raw_ansi_fg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.fmt_raw_ansi_bg" class="fn">fmt_raw_ansi_bg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait describing a runtime-configurable color which can displayed using <a href="struct.FgDynColorDisplay.html" title="struct owo_colors::FgDynColorDisplay"><code>FgDynColorDisplay</code></a>
|
||
or <a href="struct.BgDynColorDisplay.html" title="struct owo_colors::BgDynColorDisplay"><code>BgDynColorDisplay</code></a>. If your color will be known at compile time it
|
||
is recommended you avoid this.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.fmt_ansi_fg" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#129">source</a><h4 class="code-header">fn <a href="#tymethod.fmt_ansi_fg" class="fn">fmt_ansi_fg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class="docblock"><p>A function to output a ANSI code to a formatter to set the foreground to this color</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.fmt_ansi_bg" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#131">source</a><h4 class="code-header">fn <a href="#tymethod.fmt_ansi_bg" class="fn">fmt_ansi_bg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class="docblock"><p>A function to output a ANSI code to a formatter to set the background to this color</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.fmt_raw_ansi_fg" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#135">source</a><h4 class="code-header">fn <a href="#tymethod.fmt_raw_ansi_fg" class="fn">fmt_raw_ansi_fg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class="docblock"><p>A function to output a raw ANSI code to a formatter to set the foreground to this color,
|
||
but without including the ANSI delimiters.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.fmt_raw_ansi_bg" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#139">source</a><h4 class="code-header">fn <a href="#tymethod.fmt_raw_ansi_bg" class="fn">fmt_raw_ansi_bg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class="docblock"><p>A function to output a raw ANSI code to a formatter to set the background to this color,
|
||
but without including the ANSI delimiters.</p>
|
||
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-DynColor-for-str" class="impl"><a class="src rightside" href="../src/owo_colors/colors/dynamic.rs.html#45-75">source</a><a href="#impl-DynColor-for-str" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.str.html">str</a></h3></section></summary><div class="impl-items"><section id="method.fmt_ansi_fg" class="method trait-impl"><a class="src rightside" href="../src/owo_colors/colors/dynamic.rs.html#46-49">source</a><a href="#method.fmt_ansi_fg" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.fmt_ansi_fg" class="fn">fmt_ansi_fg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section><section id="method.fmt_ansi_bg" class="method trait-impl"><a class="src rightside" href="../src/owo_colors/colors/dynamic.rs.html#51-54">source</a><a href="#method.fmt_ansi_bg" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.fmt_ansi_bg" class="fn">fmt_ansi_bg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section><section id="method.fmt_raw_ansi_fg" class="method trait-impl"><a class="src rightside" href="../src/owo_colors/colors/dynamic.rs.html#56-59">source</a><a href="#method.fmt_raw_ansi_fg" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.fmt_raw_ansi_fg" class="fn">fmt_raw_ansi_fg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section><section id="method.fmt_raw_ansi_bg" class="method trait-impl"><a class="src rightside" href="../src/owo_colors/colors/dynamic.rs.html#61-64">source</a><a href="#method.fmt_raw_ansi_bg" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.fmt_raw_ansi_bg" class="fn">fmt_raw_ansi_bg</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.76.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.76.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-DynColor-for-AnsiColors" class="impl"><a class="src rightside" href="../src/owo_colors/colors.rs.html#106-125">source</a><a href="#impl-DynColor-for-AnsiColors" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a> for <a class="enum" href="enum.AnsiColors.html" title="enum owo_colors::AnsiColors">AnsiColors</a></h3></section><section id="impl-DynColor-for-CssColors" class="impl"><a class="src rightside" href="../src/owo_colors/colors/css.rs.html#82-230">source</a><a href="#impl-DynColor-for-CssColors" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a> for <a class="enum" href="enum.CssColors.html" title="enum owo_colors::CssColors">CssColors</a></h3></section><section id="impl-DynColor-for-DynColors" class="impl"><a class="src rightside" href="../src/owo_colors/dyn_colors.rs.html#19-65">source</a><a href="#impl-DynColor-for-DynColors" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a> for <a class="enum" href="enum.DynColors.html" title="enum owo_colors::DynColors">DynColors</a></h3></section><section id="impl-DynColor-for-XtermColors" class="impl"><a class="src rightside" href="../src/owo_colors/colors/xterm.rs.html#121-378">source</a><a href="#impl-DynColor-for-XtermColors" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a> for <a class="enum" href="enum.XtermColors.html" title="enum owo_colors::XtermColors">XtermColors</a></h3></section><section id="impl-DynColor-for-Rgb" class="impl"><a class="src rightside" href="../src/owo_colors/colors/dynamic.rs.html#12-43">source</a><a href="#impl-DynColor-for-Rgb" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a> for <a class="struct" href="struct.Rgb.html" title="struct owo_colors::Rgb">Rgb</a></h3></section></div><script src="../trait.impl/owo_colors/trait.DynColor.js" data-ignore-extern-crates="core" async></script></section></div></main></body></html> |