edlang/ariadne/trait.StdoutFmt.html
2024-07-26 09:42:18 +00:00

10 lines
7.2 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 used to add formatting attributes to displayable items intended to be written to `stdout`."><title>StdoutFmt 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 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" 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="#">StdoutFmt</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.bg">bg</a></li><li><a href="#method.fg">fg</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></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>Trait <a href="index.html">ariadne</a>::<wbr><a class="trait" href="#">StdoutFmt</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/draw.rs.html#179-189">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait StdoutFmt: StreamAwareFmt {
// Provided methods
fn <a href="#method.fg" class="fn">fg</a>&lt;C: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum ariadne::Color">Color</a>&gt;&gt;&gt;(self, color: C) -&gt; Foreground&lt;Self&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.bg" class="fn">bg</a>&lt;C: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum ariadne::Color">Color</a>&gt;&gt;&gt;(self, color: C) -&gt; Background&lt;Self&gt; { ... }
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait used to add formatting attributes to displayable items intended to be written to <code>stdout</code>.</p>
<p>Attributes specified through this trait are not composable (i.e: the behaviour of two nested attributes each with a
conflicting attribute is left unspecified).</p>
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.fg" class="method"><a class="src rightside" href="../src/ariadne/draw.rs.html#181-183">source</a><h4 class="code-header">fn <a href="#method.fg" class="fn">fg</a>&lt;C: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum ariadne::Color">Color</a>&gt;&gt;&gt;(self, color: C) -&gt; Foreground&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Give this value the specified foreground colour, when color is enabled for <code>stdout</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.bg" class="method"><a class="src rightside" href="../src/ariadne/draw.rs.html#186-188">source</a><h4 class="code-header">fn <a href="#method.bg" class="fn">bg</a>&lt;C: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="enum" href="https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="enum" href="enum.Color.html" title="enum ariadne::Color">Color</a>&gt;&gt;&gt;(self, color: C) -&gt; Background&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Give this value the specified background colour, when color is enabled for <code>stdout</code>.</p>
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.80.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-StdoutFmt-for-T" class="impl"><a class="src rightside" href="../src/ariadne/draw.rs.html#192">source</a><a href="#impl-StdoutFmt-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>&gt; <a class="trait" href="trait.StdoutFmt.html" title="trait ariadne::StdoutFmt">StdoutFmt</a> for T</h3></section></div><script src="../trait.impl/ariadne/draw/trait.StdoutFmt.js" async></script></section></div></main></body></html>