mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-19 09:12:24 +00:00
74 lines
43 KiB
HTML
74 lines
43 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="`std::io::Write` that adapts ANSI escape codes to the underlying `Write`s capabilities"><title>AutoStream in anstream - 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="anstream" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../anstream/index.html">anstream</a><span class="version">0.6.15</span></h2></div><h2 class="location"><a href="#">AutoStream</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.always">always</a></li><li><a href="#method.always_ansi">always_ansi</a></li><li><a href="#method.auto">auto</a></li><li><a href="#method.choice">choice</a></li><li><a href="#method.current_choice">current_choice</a></li><li><a href="#method.into_inner">into_inner</a></li><li><a href="#method.is_terminal">is_terminal</a></li><li><a href="#method.lock">lock</a></li><li><a href="#method.lock-1">lock</a></li><li><a href="#method.never">never</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Debug-for-AutoStream%3CS%3E">Debug</a></li><li><a href="#impl-Write-for-AutoStream%3CS%3E">Write</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-AutoStream%3CS%3E">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-AutoStream%3CS%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-AutoStream%3CS%3E">Send</a></li><li><a href="#impl-Sync-for-AutoStream%3CS%3E">Sync</a></li><li><a href="#impl-Unpin-for-AutoStream%3CS%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-AutoStream%3CS%3E">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-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 anstream</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="index.html">anstream</a>::<wbr><a class="struct" href="#">AutoStream</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/anstream/auto.rs.html#19-21">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct AutoStream<S: <a class="trait" href="stream/trait.RawStream.html" title="trait anstream::stream::RawStream">RawStream</a>> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html" title="trait std::io::Write"><code>std::io::Write</code></a> that adapts ANSI escape codes to the underlying <code>Write</code>s capabilities</p>
|
||
<p>This includes</p>
|
||
<ul>
|
||
<li>Stripping colors for non-terminals</li>
|
||
<li>Respecting env variables like <a href="https://no-color.org/">NO_COLOR</a> or <a href="https://bixense.com/clicolors/">CLICOLOR</a></li>
|
||
<li><em>(windows)</em> Falling back to the wincon API where <a href="https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences#output-sequences">ENABLE_VIRTUAL_TERMINAL_PROCESSING</a> is unsupported</li>
|
||
</ul>
|
||
<p>You can customize auto-detection by calling into
|
||
<a href="https://docs.rs/anstyle-query/latest/anstyle_query/">anstyle_query</a>
|
||
to get a <a href="enum.ColorChoice.html" title="enum anstream::ColorChoice"><code>ColorChoice</code></a> and then calling [<code>AutoStream::new(stream, choice)</code>].</p>
|
||
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-AutoStream%3CS%3E" class="impl"><a class="src rightside" href="../src/anstream/auto.rs.html#31-184">source</a><a href="#impl-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <a class="trait" href="stream/trait.RawStream.html" title="trait anstream::stream::RawStream">RawStream</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#62-72">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(raw: S, choice: <a class="enum" href="enum.ColorChoice.html" title="enum anstream::ColorChoice">ColorChoice</a>) -> Self</h4></section></summary><div class="docblock"><p>Runtime control over styling behavior</p>
|
||
<h5 id="example"><a class="doc-anchor" href="#example">§</a>Example</h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Like `AutoStream::choice` but without `NO_COLOR`, `CLICOLOR_FORCE`, `CI`
|
||
</span><span class="kw">fn </span>choice(raw: <span class="kw-2">&</span><span class="kw">dyn </span>anstream::stream::RawStream) -> anstream::ColorChoice {
|
||
<span class="kw">let </span>choice = anstream::ColorChoice::global();
|
||
<span class="kw">if </span>choice == anstream::ColorChoice::Auto {
|
||
<span class="kw">if </span>raw.is_terminal() && anstyle_query::term_supports_color() {
|
||
anstream::ColorChoice::Always
|
||
} <span class="kw">else </span>{
|
||
anstream::ColorChoice::Never
|
||
}
|
||
} <span class="kw">else </span>{
|
||
choice
|
||
}
|
||
}
|
||
|
||
<span class="kw">let </span>stream = std::io::stdout();
|
||
<span class="kw">let </span>choice = choice(<span class="kw-2">&</span>stream);
|
||
<span class="kw">let </span>auto = anstream::AutoStream::new(stream, choice);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.auto" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#77-81">source</a><h4 class="code-header">pub fn <a href="#method.auto" class="fn">auto</a>(raw: S) -> Self</h4></section></summary><div class="docblock"><p>Auto-adapt for the stream’s capabilities</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.choice" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#85-87">source</a><h4 class="code-header">pub fn <a href="#method.choice" class="fn">choice</a>(raw: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&S</a>) -> <a class="enum" href="enum.ColorChoice.html" title="enum anstream::ColorChoice">ColorChoice</a></h4></section></summary><div class="docblock"><p>Report the desired choice for the given stream</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.always_ansi" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#92-100">source</a><h4 class="code-header">pub fn <a href="#method.always_ansi" class="fn">always_ansi</a>(raw: S) -> Self</h4></section></summary><div class="docblock"><p>Force ANSI escape codes to be passed through as-is, no matter what the inner <code>Write</code>
|
||
supports.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.always" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#110-126">source</a><h4 class="code-header">pub fn <a href="#method.always" class="fn">always</a>(raw: S) -> Self</h4></section></summary><div class="docblock"><p>Force color, no matter what the inner <code>Write</code> supports.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.never" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#130-133">source</a><h4 class="code-header">pub fn <a href="#method.never" class="fn">never</a>(raw: S) -> Self</h4></section></summary><div class="docblock"><p>Only pass printable data to the inner <code>Write</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.into_inner" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#151-158">source</a><h4 class="code-header">pub fn <a href="#method.into_inner" class="fn">into_inner</a>(self) -> S</h4></section></summary><div class="docblock"><p>Get the wrapped <a href="stream/trait.RawStream.html" title="trait anstream::stream::RawStream"><code>RawStream</code></a></p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_terminal" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#162-169">source</a><h4 class="code-header">pub fn <a href="#method.is_terminal" class="fn">is_terminal</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the descriptor/handle refers to a terminal/tty.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.current_choice" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#176-183">source</a><h4 class="code-header">pub fn <a href="#method.current_choice" class="fn">current_choice</a>(&self) -> <a class="enum" href="enum.ColorChoice.html" title="enum anstream::ColorChoice">ColorChoice</a></h4></section></summary><div class="docblock"><p>Prefer <a href="struct.AutoStream.html#method.choice" title="associated function anstream::AutoStream::choice"><code>AutoStream::choice</code></a></p>
|
||
<p>This doesn’t report what is requested but what is currently active.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AutoStream%3CStdout%3E" class="impl"><a class="src rightside" href="../src/anstream/auto.rs.html#214-230">source</a><a href="#impl-AutoStream%3CStdout%3E" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/io/stdio/struct.Stdout.html" title="struct std::io::stdio::Stdout">Stdout</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.lock" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#221-229">source</a><h4 class="code-header">pub fn <a href="#method.lock" class="fn">lock</a>(self) -> <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/io/stdio/struct.StdoutLock.html" title="struct std::io::stdio::StdoutLock">StdoutLock</a><'static>> <a href="#" class="tooltip" data-notable-ty="AutoStream<StdoutLock<'static>>">ⓘ</a></h4></section></summary><div class="docblock"><p>Get exclusive access to the <code>AutoStream</code></p>
|
||
<p>Why?</p>
|
||
<ul>
|
||
<li>Faster performance when writing in a loop</li>
|
||
<li>Avoid other threads interleaving output with the current thread</li>
|
||
</ul>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-AutoStream%3CStderr%3E" class="impl"><a class="src rightside" href="../src/anstream/auto.rs.html#232-248">source</a><a href="#impl-AutoStream%3CStderr%3E" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/io/stdio/struct.Stderr.html" title="struct std::io::stdio::Stderr">Stderr</a>></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.lock-1" class="method"><a class="src rightside" href="../src/anstream/auto.rs.html#239-247">source</a><h4 class="code-header">pub fn <a href="#method.lock-1" class="fn">lock</a>(self) -> <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/io/stdio/struct.StderrLock.html" title="struct std::io::stdio::StderrLock">StderrLock</a><'static>> <a href="#" class="tooltip" data-notable-ty="AutoStream<StderrLock<'static>>">ⓘ</a></h4></section></summary><div class="docblock"><p>Get exclusive access to the <code>AutoStream</code></p>
|
||
<p>Why?</p>
|
||
<ul>
|
||
<li>Faster performance when writing in a loop</li>
|
||
<li>Avoid other threads interleaving output with the current thread</li>
|
||
</ul>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-AutoStream%3CS%3E" class="impl"><a class="src rightside" href="../src/anstream/auto.rs.html#18">source</a><a href="#impl-Debug-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="stream/trait.RawStream.html" title="trait anstream::stream::RawStream">RawStream</a>> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S></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/anstream/auto.rs.html#18">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-Write-for-AutoStream%3CS%3E" class="impl"><a class="src rightside" href="../src/anstream/auto.rs.html#250-302">source</a><a href="#impl-Write-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <a class="trait" href="stream/trait.RawStream.html" title="trait anstream::stream::RawStream">RawStream</a> + <a class="trait" href="stream/trait.AsLockedWrite.html" title="trait anstream::stream::AsLockedWrite">AsLockedWrite</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.write" class="method trait-impl"><a class="src rightside" href="../src/anstream/auto.rs.html#256-263">source</a><a href="#method.write" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#tymethod.write" class="fn">write</a>(&mut self, buf: &[<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>]) -> <a class="type" href="https://doc.rust-lang.org/1.80.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>></h4></section></summary><div class='docblock'>Write a buffer into this writer, returning how many bytes were written. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#tymethod.write">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_vectored" class="method trait-impl"><a class="src rightside" href="../src/anstream/auto.rs.html#265-272">source</a><a href="#method.write_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_vectored" class="fn">write_vectored</a>(&mut self, bufs: &[<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'_>]) -> <a class="type" href="https://doc.rust-lang.org/1.80.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.usize.html">usize</a>></h4></section></summary><div class='docblock'>Like <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#tymethod.write" title="method std::io::Write::write"><code>write</code></a>, except that it writes from a slice of buffers. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_vectored">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.flush" class="method trait-impl"><a class="src rightside" href="../src/anstream/auto.rs.html#275-282">source</a><a href="#method.flush" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#tymethod.flush" class="fn">flush</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.80.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>></h4></section></summary><div class='docblock'>Flush this output stream, ensuring that all intermediately buffered
|
||
contents reach their destination. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#tymethod.flush">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_all" class="method trait-impl"><a class="src rightside" href="../src/anstream/auto.rs.html#284-291">source</a><a href="#method.write_all" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_all" class="fn">write_all</a>(&mut self, buf: &[<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.u8.html">u8</a>]) -> <a class="type" href="https://doc.rust-lang.org/1.80.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>></h4></section></summary><div class='docblock'>Attempts to write an entire buffer into this writer. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_all">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_fmt" class="method trait-impl"><a class="src rightside" href="../src/anstream/auto.rs.html#294-301">source</a><a href="#method.write_fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_fmt" class="fn">write_fmt</a>(&mut self, args: <a class="struct" href="https://doc.rust-lang.org/1.80.0/core/fmt/struct.Arguments.html" title="struct core::fmt::Arguments">Arguments</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.80.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>></h4></section></summary><div class='docblock'>Writes a formatted string into this writer, returning any error
|
||
encountered. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_fmt">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.is_write_vectored" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/std/io/mod.rs.html#1637">source</a><a href="#method.is_write_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.is_write_vectored" class="fn">is_write_vectored</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.bool.html">bool</a></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>can_vector</code>)</span></div></span><div class='docblock'>Determines if this <code>Write</code>r has an efficient <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_vectored" title="method std::io::Write::write_vectored"><code>write_vectored</code></a>
|
||
implementation. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.is_write_vectored">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.write_all_vectored" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.80.0/src/std/io/mod.rs.html#1761">source</a><a href="#method.write_all_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_all_vectored" class="fn">write_all_vectored</a>(&mut self, bufs: &mut [<a class="struct" href="https://doc.rust-lang.org/1.80.0/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'_>]) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.80.0/std/io/error/struct.Error.html" title="struct std::io::error::Error">Error</a>></h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>write_all_vectored</code>)</span></div></span><div class='docblock'>Attempts to write multiple buffers into this writer. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.write_all_vectored">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.by_ref" 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/std/io/mod.rs.html#1874-1876">source</a></span><a href="#method.by_ref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.by_ref" class="fn">by_ref</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&mut Self</a><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'>Creates a “by reference” adapter for this instance of <code>Write</code>. <a href="https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html#method.by_ref">Read more</a></div></details></div></details></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-AutoStream%3CS%3E" class="impl"><a href="#impl-Freeze-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-AutoStream%3CS%3E" class="impl"><a href="#impl-RefUnwindSafe-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <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>,</div></h3></section><section id="impl-Send-for-AutoStream%3CS%3E" class="impl"><a href="#impl-Send-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-AutoStream%3CS%3E" class="impl"><a href="#impl-Sync-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-AutoStream%3CS%3E" class="impl"><a href="#impl-Unpin-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-AutoStream%3CS%3E" class="impl"><a href="#impl-UnwindSafe-for-AutoStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><S><div class="where">where
|
||
S: <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>,</div></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-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><script type="text/json" id="notable-traits-data">{"AutoStream<StderrLock<'static>>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.AutoStream.html\" title=\"struct anstream::AutoStream\">AutoStream</a><S></code></h3><pre><code><div class=\"where\">impl<S> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"struct.AutoStream.html\" title=\"struct anstream::AutoStream\">AutoStream</a><S><div class=\"where\">where\n S: <a class=\"trait\" href=\"stream/trait.RawStream.html\" title=\"trait anstream::stream::RawStream\">RawStream</a> + <a class=\"trait\" href=\"stream/trait.AsLockedWrite.html\" title=\"trait anstream::stream::AsLockedWrite\">AsLockedWrite</a>,</div></div>","AutoStream<StdoutLock<'static>>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.AutoStream.html\" title=\"struct anstream::AutoStream\">AutoStream</a><S></code></h3><pre><code><div class=\"where\">impl<S> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.80.0/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"struct.AutoStream.html\" title=\"struct anstream::AutoStream\">AutoStream</a><S><div class=\"where\">where\n S: <a class=\"trait\" href=\"stream/trait.RawStream.html\" title=\"trait anstream::stream::RawStream\">RawStream</a> + <a class=\"trait\" href=\"stream/trait.AsLockedWrite.html\" title=\"trait anstream::stream::AsLockedWrite\">AsLockedWrite</a>,</div></div>"}</script></section></div></main></body></html> |