mirror of
https://github.com/NotAShelf/mpvrc.git
synced 2026-04-18 00:38:14 +00:00
deploy: de38ae62916547ad097c066f94a32e9ba7790eeb
This commit is contained in:
commit
9a86359447
28502 changed files with 1261284 additions and 0 deletions
10
anstream/adapter/fn.strip_bytes.html
Normal file
10
anstream/adapter/fn.strip_bytes.html
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<!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="Strip ANSI escapes from bytes, returning the printable content"><title>strip_bytes in anstream::adapter - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">strip_<wbr>bytes</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In anstream::<wbr>adapter</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">anstream</a>::<wbr><a href="index.html">adapter</a></span><h1>Function <span class="fn">strip_bytes</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/anstream/adapter/strip.rs.html#178-180">Source</a> </span></div><pre class="rust item-decl"><code>pub fn strip_bytes(data: &[<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>]) -> <a class="struct" href="struct.StrippedBytes.html" title="struct anstream::adapter::StrippedBytes">StrippedBytes</a><'_> <a href="#" class="tooltip" data-notable-ty="StrippedBytes<'_>">ⓘ</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Strip ANSI escapes from bytes, returning the printable content</p>
|
||||
<p>This can be used to take output from a program that includes escape sequences and write it
|
||||
somewhere that does not easily support them, such as a log file.</p>
|
||||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::Write <span class="kw">as _</span>;
|
||||
|
||||
<span class="kw">let </span>styled_text = <span class="string">"\x1b[32mfoo\x1b[m bar"</span>;
|
||||
<span class="kw">let </span>plain_str = anstream::adapter::strip_bytes(styled_text.as_bytes()).into_vec();
|
||||
<span class="macro">assert_eq!</span>(plain_str.as_slice(), <span class="kw-2">&</span><span class="string">b"foo bar"</span>[..]);</code></pre></div>
|
||||
</div></details><script type="text/json" id="notable-traits-data">{"StrippedBytes<'_>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.StrippedBytes.html\" title=\"struct anstream::adapter::StrippedBytes\">StrippedBytes</a><'s></code></h3><pre><code><div class=\"where\">impl<'s> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.StrippedBytes.html\" title=\"struct anstream::adapter::StrippedBytes\">StrippedBytes</a><'s></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = &'s [<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.1/std/primitive.u8.html\">u8</a>];</div>"}</script></section></div></main></body></html>
|
||||
11
anstream/adapter/fn.strip_str.html
Normal file
11
anstream/adapter/fn.strip_str.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!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="Strip ANSI escapes from a `&str`, returning the printable content"><title>strip_str in anstream::adapter - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">strip_<wbr>str</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In anstream::<wbr>adapter</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">anstream</a>::<wbr><a href="index.html">adapter</a></span><h1>Function <span class="fn">strip_str</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/anstream/adapter/strip.rs.html#22-24">Source</a> </span></div><pre class="rust item-decl"><code>pub fn strip_str(data: &<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.str.html">str</a>) -> <a class="struct" href="struct.StrippedStr.html" title="struct anstream::adapter::StrippedStr">StrippedStr</a><'_> <a href="#" class="tooltip" data-notable-ty="StrippedStr<'_>">ⓘ</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Strip ANSI escapes from a <code>&str</code>, returning the printable content</p>
|
||||
<p>This can be used to take output from a program that includes escape sequences and write it
|
||||
somewhere that does not easily support them, such as a log file.</p>
|
||||
<p>For non-contiguous data, see <a href="struct.StripStr.html" title="struct anstream::adapter::StripStr"><code>StripStr</code></a>.</p>
|
||||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::Write <span class="kw">as _</span>;
|
||||
|
||||
<span class="kw">let </span>styled_text = <span class="string">"\x1b[32mfoo\x1b[m bar"</span>;
|
||||
<span class="kw">let </span>plain_str = anstream::adapter::strip_str(<span class="kw-2">&</span>styled_text).to_string();
|
||||
<span class="macro">assert_eq!</span>(plain_str, <span class="string">"foo bar"</span>);</code></pre></div>
|
||||
</div></details><script type="text/json" id="notable-traits-data">{"StrippedStr<'_>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.StrippedStr.html\" title=\"struct anstream::adapter::StrippedStr\">StrippedStr</a><'s></code></h3><pre><code><div class=\"where\">impl<'s> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.StrippedStr.html\" title=\"struct anstream::adapter::StrippedStr\">StrippedStr</a><'s></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = &'s <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.1/std/primitive.str.html\">str</a>;</div>"}</script></section></div></main></body></html>
|
||||
2
anstream/adapter/index.html
Normal file
2
anstream/adapter/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!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="Gracefully degrade styled output"><title>anstream::adapter - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module adapter</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">anstream</a></span><h1>Module <span>adapter</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/anstream/adapter/mod.rs.html#1-15">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Gracefully degrade styled output</p>
|
||||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.StripBytes.html" title="struct anstream::adapter::StripBytes">Strip<wbr>Bytes</a></div><div class="desc docblock-short">Incrementally strip non-contiguous data</div></li><li><div class="item-name"><a class="struct" href="struct.StripBytesIter.html" title="struct anstream::adapter::StripBytesIter">Strip<wbr>Bytes<wbr>Iter</a></div><div class="desc docblock-short">See <a href="struct.StripBytes.html" title="struct anstream::adapter::StripBytes"><code>StripBytes</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.StripStr.html" title="struct anstream::adapter::StripStr">Strip<wbr>Str</a></div><div class="desc docblock-short">Incrementally strip non-contiguous data</div></li><li><div class="item-name"><a class="struct" href="struct.StripStrIter.html" title="struct anstream::adapter::StripStrIter">Strip<wbr>StrIter</a></div><div class="desc docblock-short">See <a href="struct.StripStr.html" title="struct anstream::adapter::StripStr"><code>StripStr</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.StrippedBytes.html" title="struct anstream::adapter::StrippedBytes">Stripped<wbr>Bytes</a></div><div class="desc docblock-short">See <a href="fn.strip_bytes.html" title="fn anstream::adapter::strip_bytes"><code>strip_bytes</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.StrippedStr.html" title="struct anstream::adapter::StrippedStr">Stripped<wbr>Str</a></div><div class="desc docblock-short">See <a href="fn.strip_str.html" title="fn anstream::adapter::strip_str"><code>strip_str</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.WinconBytes.html" title="struct anstream::adapter::WinconBytes">Wincon<wbr>Bytes</a></div><div class="desc docblock-short">Incrementally convert to wincon calls for non-contiguous data</div></li><li><div class="item-name"><a class="struct" href="struct.WinconBytesIter.html" title="struct anstream::adapter::WinconBytesIter">Wincon<wbr>Bytes<wbr>Iter</a></div><div class="desc docblock-short">See <a href="struct.WinconBytes.html" title="struct anstream::adapter::WinconBytes"><code>WinconBytes</code></a></div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.strip_bytes.html" title="fn anstream::adapter::strip_bytes">strip_<wbr>bytes</a></div><div class="desc docblock-short">Strip ANSI escapes from bytes, returning the printable content</div></li><li><div class="item-name"><a class="fn" href="fn.strip_str.html" title="fn anstream::adapter::strip_str">strip_<wbr>str</a></div><div class="desc docblock-short">Strip ANSI escapes from a <code>&str</code>, returning the printable content</div></li></ul></section></div></main></body></html>
|
||||
1
anstream/adapter/sidebar-items.js
Normal file
1
anstream/adapter/sidebar-items.js
Normal file
|
|
@ -0,0 +1 @@
|
|||
window.SIDEBAR_ITEMS = {"fn":["strip_bytes","strip_str"],"struct":["StripBytes","StripBytesIter","StripStr","StripStrIter","StrippedBytes","StrippedStr","WinconBytes","WinconBytesIter"]};
|
||||
11
anstream/adapter/strip/fn.strip_bytes.html
Normal file
11
anstream/adapter/strip/fn.strip_bytes.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/fn.strip_bytes.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/fn.strip_bytes.html">../../../anstream/adapter/fn.strip_bytes.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/fn.strip_bytes.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/strip/fn.strip_str.html
Normal file
11
anstream/adapter/strip/fn.strip_str.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/fn.strip_str.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/fn.strip_str.html">../../../anstream/adapter/fn.strip_str.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/fn.strip_str.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/strip/struct.StripBytes.html
Normal file
11
anstream/adapter/strip/struct.StripBytes.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.StripBytes.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.StripBytes.html">../../../anstream/adapter/struct.StripBytes.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.StripBytes.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/strip/struct.StripBytesIter.html
Normal file
11
anstream/adapter/strip/struct.StripBytesIter.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.StripBytesIter.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.StripBytesIter.html">../../../anstream/adapter/struct.StripBytesIter.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.StripBytesIter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/strip/struct.StripStr.html
Normal file
11
anstream/adapter/strip/struct.StripStr.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.StripStr.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.StripStr.html">../../../anstream/adapter/struct.StripStr.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.StripStr.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/strip/struct.StripStrIter.html
Normal file
11
anstream/adapter/strip/struct.StripStrIter.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.StripStrIter.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.StripStrIter.html">../../../anstream/adapter/struct.StripStrIter.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.StripStrIter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/strip/struct.StrippedBytes.html
Normal file
11
anstream/adapter/strip/struct.StrippedBytes.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.StrippedBytes.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.StrippedBytes.html">../../../anstream/adapter/struct.StrippedBytes.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.StrippedBytes.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/strip/struct.StrippedStr.html
Normal file
11
anstream/adapter/strip/struct.StrippedStr.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.StrippedStr.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.StrippedStr.html">../../../anstream/adapter/struct.StrippedStr.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.StrippedStr.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
17
anstream/adapter/struct.StripBytes.html
Normal file
17
anstream/adapter/struct.StripBytes.html
Normal file
File diff suppressed because one or more lines are too long
211
anstream/adapter/struct.StripBytesIter.html
Normal file
211
anstream/adapter/struct.StripBytesIter.html
Normal file
File diff suppressed because one or more lines are too long
17
anstream/adapter/struct.StripStr.html
Normal file
17
anstream/adapter/struct.StripStr.html
Normal file
File diff suppressed because one or more lines are too long
211
anstream/adapter/struct.StripStrIter.html
Normal file
211
anstream/adapter/struct.StripStrIter.html
Normal file
File diff suppressed because one or more lines are too long
221
anstream/adapter/struct.StrippedBytes.html
Normal file
221
anstream/adapter/struct.StrippedBytes.html
Normal file
File diff suppressed because one or more lines are too long
217
anstream/adapter/struct.StrippedStr.html
Normal file
217
anstream/adapter/struct.StrippedStr.html
Normal file
File diff suppressed because one or more lines are too long
17
anstream/adapter/struct.WinconBytes.html
Normal file
17
anstream/adapter/struct.WinconBytes.html
Normal file
File diff suppressed because one or more lines are too long
211
anstream/adapter/struct.WinconBytesIter.html
Normal file
211
anstream/adapter/struct.WinconBytesIter.html
Normal file
File diff suppressed because one or more lines are too long
11
anstream/adapter/wincon/struct.WinconBytes.html
Normal file
11
anstream/adapter/wincon/struct.WinconBytes.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.WinconBytes.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.WinconBytes.html">../../../anstream/adapter/struct.WinconBytes.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.WinconBytes.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
11
anstream/adapter/wincon/struct.WinconBytesIter.html
Normal file
11
anstream/adapter/wincon/struct.WinconBytesIter.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../../anstream/adapter/struct.WinconBytesIter.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../../anstream/adapter/struct.WinconBytesIter.html">../../../anstream/adapter/struct.WinconBytesIter.html</a>...</p>
|
||||
<script>location.replace("../../../anstream/adapter/struct.WinconBytesIter.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
1
anstream/all.html
Normal file
1
anstream/all.html
Normal file
|
|
@ -0,0 +1 @@
|
|||
<!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="List of all items in this crate"><title>List of all items in this crate</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod sys"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#macros">Crate Items</a></h3><ul class="block"><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.AutoStream.html">AutoStream</a></li><li><a href="struct.StripStream.html">StripStream</a></li><li><a href="adapter/struct.StripBytes.html">adapter::StripBytes</a></li><li><a href="adapter/struct.StripBytesIter.html">adapter::StripBytesIter</a></li><li><a href="adapter/struct.StripStr.html">adapter::StripStr</a></li><li><a href="adapter/struct.StripStrIter.html">adapter::StripStrIter</a></li><li><a href="adapter/struct.StrippedBytes.html">adapter::StrippedBytes</a></li><li><a href="adapter/struct.StrippedStr.html">adapter::StrippedStr</a></li><li><a href="adapter/struct.WinconBytes.html">adapter::WinconBytes</a></li><li><a href="adapter/struct.WinconBytesIter.html">adapter::WinconBytesIter</a></li></ul><h3 id="enums">Enums</h3><ul class="all-items"><li><a href="enum.ColorChoice.html">ColorChoice</a></li></ul><h3 id="traits">Traits</h3><ul class="all-items"><li><a href="stream/trait.AsLockedWrite.html">stream::AsLockedWrite</a></li><li><a href="stream/trait.IsTerminal.html">stream::IsTerminal</a></li><li><a href="stream/trait.RawStream.html">stream::RawStream</a></li></ul><h3 id="macros">Macros</h3><ul class="all-items"><li><a href="macro.eprint.html">eprint</a></li><li><a href="macro.eprintln.html">eprintln</a></li><li><a href="macro.panic.html">panic</a></li><li><a href="macro.print.html">print</a></li><li><a href="macro.println.html">println</a></li></ul><h3 id="functions">Functions</h3><ul class="all-items"><li><a href="adapter/fn.strip_bytes.html">adapter::strip_bytes</a></li><li><a href="adapter/fn.strip_str.html">adapter::strip_str</a></li><li><a href="fn.stderr.html">stderr</a></li><li><a href="fn.stdout.html">stdout</a></li></ul><h3 id="types">Type Aliases</h3><ul class="all-items"><li><a href="type.Stderr.html">Stderr</a></li><li><a href="type.Stdout.html">Stdout</a></li></ul></section></div></main></body></html>
|
||||
11
anstream/auto/struct.AutoStream.html
Normal file
11
anstream/auto/struct.AutoStream.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../anstream/struct.AutoStream.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../anstream/struct.AutoStream.html">../../anstream/struct.AutoStream.html</a>...</p>
|
||||
<script>location.replace("../../anstream/struct.AutoStream.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
29
anstream/enum.ColorChoice.html
Normal file
29
anstream/enum.ColorChoice.html
Normal file
File diff suppressed because one or more lines are too long
4
anstream/fn.stderr.html
Normal file
4
anstream/fn.stderr.html
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<!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="Create an ANSI escape code compatible stderr"><title>stderr in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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.18</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Function <span class="fn">stderr</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/lib.rs.html#80-83">Source</a> </span></div><pre class="rust item-decl"><code>pub fn stderr() -> <a class="type" href="type.Stderr.html" title="type anstream::Stderr">Stderr</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create an ANSI escape code compatible stderr</p>
|
||||
<p><strong>Note:</strong> Call <a href="struct.AutoStream.html#method.lock" title="method anstream::AutoStream::lock"><code>AutoStream::lock</code></a> in loops to avoid the performance hit of acquiring/releasing
|
||||
from the implicit locking in each <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write"><code>std::io::Write</code></a> call</p>
|
||||
</div></details></section></div></main></body></html>
|
||||
4
anstream/fn.stdout.html
Normal file
4
anstream/fn.stdout.html
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<!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="Create an ANSI escape code compatible stdout"><title>stdout in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[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.18</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Function <span class="fn">stdout</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/lib.rs.html#70-73">Source</a> </span></div><pre class="rust item-decl"><code>pub fn stdout() -> <a class="type" href="type.Stdout.html" title="type anstream::Stdout">Stdout</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create an ANSI escape code compatible stdout</p>
|
||||
<p><strong>Note:</strong> Call <a href="struct.AutoStream.html#method.lock" title="method anstream::AutoStream::lock"><code>AutoStream::lock</code></a> in loops to avoid the performance hit of acquiring/releasing
|
||||
from the implicit locking in each <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write"><code>std::io::Write</code></a> call</p>
|
||||
</div></details></section></div></main></body></html>
|
||||
27
anstream/index.html
Normal file
27
anstream/index.html
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
<!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="Auto-adapting `stdout` / `stderr` streams"><title>anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[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.18</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></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>Crate <span>anstream</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/lib.rs.html#1-86">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><strong>Auto-adapting <a href="fn.stdout.html" title="fn anstream::stdout"><code>stdout</code></a> / <a href="fn.stderr.html" title="fn anstream::stderr"><code>stderr</code></a> streams</strong></p>
|
||||
<p><em>A portmanteau of “ansi stream”</em></p>
|
||||
<p><a href="struct.AutoStream.html" title="struct anstream::AutoStream"><code>AutoStream</code></a> always accepts <a href="https://en.wikipedia.org/wiki/ANSI_escape_code">ANSI escape codes</a>,
|
||||
<a href="struct.AutoStream.html" title="struct anstream::AutoStream">adapting to the user’s terminal’s capabilities</a>.</p>
|
||||
<p>Benefits</p>
|
||||
<ul>
|
||||
<li>Allows the caller to not be concerned with the terminal’s capabilities</li>
|
||||
<li>Semver safe way of passing styled text between crates as ANSI escape codes offer more
|
||||
compatibility than most crate APIs.</li>
|
||||
</ul>
|
||||
<p>Available styling crates:</p>
|
||||
<ul>
|
||||
<li><a href="https://docs.rs/anstyle">anstyle</a> for minimal runtime styling, designed to go in public APIs</li>
|
||||
<li><a href="https://docs.rs/owo-colors">owo-colors</a> for feature-rich runtime styling</li>
|
||||
<li><a href="https://docs.rs/color-print">color-print</a> for feature-rich compile-time styling</li>
|
||||
</ul>
|
||||
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>anstream::println;
|
||||
<span class="kw">use </span>owo_colors::OwoColorize <span class="kw">as _</span>;
|
||||
|
||||
<span class="comment">// Foreground colors
|
||||
</span><span class="macro">println!</span>(<span class="string">"My number is {:#x}!"</span>, <span class="number">10</span>.green());
|
||||
<span class="comment">// Background colors
|
||||
</span><span class="macro">println!</span>(<span class="string">"My number is not {}!"</span>, <span class="number">4</span>.on_red());</code></pre></div>
|
||||
<p>And this will correctly handle piping to a file, etc</p>
|
||||
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.Buffer"><code>pub use buffer::Buffer;</code></div><div class="desc docblock-short"><wbr><span class="stab deprecated" title="">Deprecated</span></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="adapter/index.html" title="mod anstream::adapter">adapter</a></div><div class="desc docblock-short">Gracefully degrade styled output</div></li><li><div class="item-name"><a class="mod" href="stream/index.html" title="mod anstream::stream">stream</a></div><div class="desc docblock-short">Higher-level traits to describe writeable streams</div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.eprint.html" title="macro anstream::eprint">eprint</a></div><div class="desc docblock-short">Prints to <a href="fn.stderr.html" title="fn anstream::stderr"><code>stderr</code></a>.</div></li><li><div class="item-name"><a class="macro" href="macro.eprintln.html" title="macro anstream::eprintln">eprintln</a></div><div class="desc docblock-short">Prints to <a href="fn.stderr.html" title="fn anstream::stderr"><code>stderr</code></a>, with a newline.</div></li><li><div class="item-name"><a class="macro" href="macro.panic.html" title="macro anstream::panic">panic</a></div><div class="desc docblock-short">Panics the current thread.</div></li><li><div class="item-name"><a class="macro" href="macro.print.html" title="macro anstream::print">print</a></div><div class="desc docblock-short">Prints to <a href="fn.stdout.html" title="fn anstream::stdout"><code>stdout</code></a>.</div></li><li><div class="item-name"><a class="macro" href="macro.println.html" title="macro anstream::println">println</a></div><div class="desc docblock-short">Prints to <a href="fn.stdout.html" title="fn anstream::stdout"><code>stdout</code></a>, with a newline.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">Auto<wbr>Stream</a></div><div class="desc docblock-short"><a href="https://doc.rust-lang.org/1.84.1/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</div></li><li><div class="item-name"><a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">Strip<wbr>Stream</a></div><div class="desc docblock-short">Only pass printable data to the inner <code>Write</code></div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ColorChoice.html" title="enum anstream::ColorChoice">Color<wbr>Choice</a></div><div class="desc docblock-short">Selection for overriding color output
|
||||
Selection for overriding color output</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.stderr.html" title="fn anstream::stderr">stderr</a></div><div class="desc docblock-short">Create an ANSI escape code compatible stderr</div></li><li><div class="item-name"><a class="fn" href="fn.stdout.html" title="fn anstream::stdout">stdout</a></div><div class="desc docblock-short">Create an ANSI escape code compatible stdout</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Stderr.html" title="type anstream::Stderr">Stderr</a></div><div class="desc docblock-short">An adaptive wrapper around the global standard error stream of the current process</div></li><li><div class="item-name"><a class="type" href="type.Stdout.html" title="type anstream::Stdout">Stdout</a></div><div class="desc docblock-short">An adaptive wrapper around the global standard output stream of the current process</div></li></ul></section></div></main></body></html>
|
||||
11
anstream/macro.eprint!.html
Normal file
11
anstream/macro.eprint!.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.eprint.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.eprint.html">macro.eprint.html</a>...</p>
|
||||
<script>location.replace("macro.eprint.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
22
anstream/macro.eprint.html
Normal file
22
anstream/macro.eprint.html
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
<!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="Prints to `stderr`."><title>eprint in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">eprint</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Macro <span class="macro">eprint</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/_macros.rs.html#184-202">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! eprint {
|
||||
($($arg:tt)*) => { ... };
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Prints to <a href="fn.stderr.html" title="fn anstream::stderr"><code>stderr</code></a>.</p>
|
||||
<p>Equivalent to the <a href="macro.print.html" title="macro anstream::print"><code>print!</code></a> macro, except that output goes to
|
||||
<code>stderr</code> instead of <code>stdout</code>. See <a href="macro.print.html" title="macro anstream::print"><code>print!</code></a> for
|
||||
example usage.</p>
|
||||
<p>Use <code>eprint!</code> only for error and progress messages. Use <code>print!</code>
|
||||
instead for the primary output of your program.</p>
|
||||
<p><strong>NOTE:</strong> Not all <code>eprint!</code> calls will be captured in tests like <a href="https://doc.rust-lang.org/1.84.1/std/macro.eprint.html" title="macro std::eprint"><code>std::eprint!</code></a></p>
|
||||
<ul>
|
||||
<li>Capturing will automatically be activated in test binaries</li>
|
||||
<li>Otherwise, only when the <code>test</code> feature is enabled</li>
|
||||
</ul>
|
||||
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||||
<p>Panics if writing to <code>stderr</code> fails for any reason <strong>except</strong> broken pipe.</p>
|
||||
<p>Writing to non-blocking stdout can cause an error, which will lead
|
||||
this macro to panic.</p>
|
||||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>anstream::eprint;
|
||||
|
||||
<span class="macro">eprint!</span>(<span class="string">"Error: Could not complete task"</span>);</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
11
anstream/macro.eprintln!.html
Normal file
11
anstream/macro.eprintln!.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.eprintln.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.eprintln.html">macro.eprintln.html</a>...</p>
|
||||
<script>location.replace("macro.eprintln.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
23
anstream/macro.eprintln.html
Normal file
23
anstream/macro.eprintln.html
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
<!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="Prints to `stderr`, with a newline."><title>eprintln in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">eprintln</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Macro <span class="macro">eprintln</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/_macros.rs.html#235-256">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! eprintln {
|
||||
() => { ... };
|
||||
($($arg:tt)*) => { ... };
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Prints to <a href="fn.stderr.html" title="fn anstream::stderr"><code>stderr</code></a>, with a newline.</p>
|
||||
<p>Equivalent to the <a href="https://doc.rust-lang.org/1.84.1/std/macro.println.html" title="macro std::println"><code>println!</code></a> macro, except that output goes to
|
||||
<code>stderr</code> instead of <code>stdout</code>. See <a href="https://doc.rust-lang.org/1.84.1/std/macro.println.html" title="macro std::println"><code>println!</code></a> for
|
||||
example usage.</p>
|
||||
<p>Use <code>eprintln!</code> only for error and progress messages. Use <code>println!</code>
|
||||
instead for the primary output of your program.</p>
|
||||
<p><strong>NOTE:</strong> Not all <code>eprintln!</code> calls will be captured in tests like <a href="https://doc.rust-lang.org/1.84.1/std/macro.eprintln.html" title="macro std::eprintln"><code>std::eprintln!</code></a></p>
|
||||
<ul>
|
||||
<li>Capturing will automatically be activated in test binaries</li>
|
||||
<li>Otherwise, only when the <code>test</code> feature is enabled</li>
|
||||
</ul>
|
||||
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||||
<p>Panics if writing to <code>stderr</code> fails for any reason <strong>except</strong> broken pipe.</p>
|
||||
<p>Writing to non-blocking stdout can cause an error, which will lead
|
||||
this macro to panic.</p>
|
||||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>anstream::eprintln;
|
||||
|
||||
<span class="macro">eprintln!</span>(<span class="string">"Error: Could not complete task"</span>);</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
11
anstream/macro.panic!.html
Normal file
11
anstream/macro.panic!.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.panic.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.panic.html">macro.panic.html</a>...</p>
|
||||
<script>location.replace("macro.panic.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
52
anstream/macro.panic.html
Normal file
52
anstream/macro.panic.html
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
<!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="Panics the current thread."><title>panic in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">panic</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#when-to-use-panic-vs-result" title="When to use `panic!` vs `Result`">When to use <code>panic!</code> vs <code>Result</code></a></li><li><a href="#current-implementation" title="Current implementation">Current implementation</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Macro <span class="macro">panic</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/_macros.rs.html#335-344">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! panic {
|
||||
() => { ... };
|
||||
($($arg:tt)*) => { ... };
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Panics the current thread.</p>
|
||||
<p>This allows a program to terminate immediately and provide feedback
|
||||
to the caller of the program.</p>
|
||||
<p>This macro is the perfect way to assert conditions in example code and in
|
||||
tests. <code>panic!</code> is closely tied with the <code>unwrap</code> method of both
|
||||
<a href="https://doc.rust-lang.org/1.84.1/core/option/enum.Option.html#method.unwrap" title="method core::option::Option::unwrap"><code>Option</code></a> and <a href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html#method.unwrap" title="method core::result::Result::unwrap"><code>Result</code></a> enums. Both implementations call
|
||||
<code>panic!</code> when they are set to <a href="https://doc.rust-lang.org/1.84.1/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> or <a href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html#variant.Err" title="variant core::result::Result::Err"><code>Err</code></a> variants.</p>
|
||||
<p>When using <code>panic!()</code> you can specify a string payload, that is built using
|
||||
the <a href="../std/macro.format.html"><code>format!</code></a> syntax. That payload is used when injecting the panic into
|
||||
the calling Rust thread, causing the thread to panic entirely.</p>
|
||||
<p>The behavior of the default <code>std</code> hook, i.e. the code that runs directly
|
||||
after the panic is invoked, is to print the message payload to
|
||||
<code>stderr</code> along with the file/line/column information of the <code>panic!()</code>
|
||||
call. You can override the panic hook using <a href="../std/panic/fn.set_hook.html"><code>std::panic::set_hook()</code></a>.
|
||||
Inside the hook a panic can be accessed as a <code>&dyn Any + Send</code>,
|
||||
which contains either a <code>&str</code> or <code>String</code> for regular <code>panic!()</code> invocations.
|
||||
To panic with a value of another other type, <a href="../std/panic/fn.panic_any.html"><code>panic_any</code></a> can be used.</p>
|
||||
<p>See also the macro <a href="https://doc.rust-lang.org/1.84.1/core/macro.compile_error.html" title="macro core::compile_error"><code>compile_error!</code></a>, for raising errors during compilation.</p>
|
||||
<h2 id="when-to-use-panic-vs-result"><a class="doc-anchor" href="#when-to-use-panic-vs-result">§</a>When to use <code>panic!</code> vs <code>Result</code></h2>
|
||||
<p>The Rust language provides two complementary systems for constructing /
|
||||
representing, reporting, propagating, reacting to, and discarding errors. These
|
||||
responsibilities are collectively known as “error handling.” <code>panic!</code> and
|
||||
<code>Result</code> are similar in that they are each the primary interface of their
|
||||
respective error handling systems; however, the meaning these interfaces attach
|
||||
to their errors and the responsibilities they fulfill within their respective
|
||||
error handling systems differ.</p>
|
||||
<p>The <code>panic!</code> macro is used to construct errors that represent a bug that has
|
||||
been detected in your program. With <code>panic!</code> you provide a message that
|
||||
describes the bug and the language then constructs an error with that message,
|
||||
reports it, and propagates it for you.</p>
|
||||
<p><code>Result</code> on the other hand is used to wrap other types that represent either
|
||||
the successful result of some computation, <code>Ok(T)</code>, or error types that
|
||||
represent an anticipated runtime failure mode of that computation, <code>Err(E)</code>.
|
||||
<code>Result</code> is used alongside user defined types which represent the various
|
||||
anticipated runtime failure modes that the associated computation could
|
||||
encounter. <code>Result</code> must be propagated manually, often with the the help of the
|
||||
<code>?</code> operator and <code>Try</code> trait, and they must be reported manually, often with
|
||||
the help of the <code>Error</code> trait.</p>
|
||||
<p>For more detailed information about error handling check out the <a href="../book/ch09-00-error-handling.html">book</a> or the
|
||||
<a href="../std/result/index.html"><code>std::result</code></a> module docs.</p>
|
||||
<h2 id="current-implementation"><a class="doc-anchor" href="#current-implementation">§</a>Current implementation</h2>
|
||||
<p>If the main thread panics it will terminate all your threads and end your
|
||||
program with code <code>101</code>.</p>
|
||||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||||
<div class="example-wrap should_panic"><a href="#" class="tooltip" title="This example panics">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">use </span>anstream::panic;
|
||||
<span class="macro">panic!</span>();
|
||||
<span class="macro">panic!</span>(<span class="string">"this is a terrible mistake!"</span>);
|
||||
<span class="macro">panic!</span>(<span class="string">"this is a {} {message}"</span>, <span class="string">"fancy"</span>, message = <span class="string">"message"</span>);</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
11
anstream/macro.print!.html
Normal file
11
anstream/macro.print!.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.print.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.print.html">macro.print.html</a>...</p>
|
||||
<script>location.replace("macro.print.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
46
anstream/macro.print.html
Normal file
46
anstream/macro.print.html
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
<!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="Prints to `stdout`."><title>print in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">print</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Macro <span class="macro">print</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/_macros.rs.html#61-79">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! print {
|
||||
($($arg:tt)*) => { ... };
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Prints to <a href="fn.stdout.html" title="fn anstream::stdout"><code>stdout</code></a>.</p>
|
||||
<p>Equivalent to the <a href="https://doc.rust-lang.org/1.84.1/std/macro.println.html" title="macro std::println"><code>println!</code></a> macro except that a newline is not printed at
|
||||
the end of the message.</p>
|
||||
<p>Note that stdout is frequently line-buffered by default so it may be
|
||||
necessary to use <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html#tymethod.flush" title="method std::io::Write::flush"><code>std::io::Write::flush()</code></a> to ensure the output is emitted
|
||||
immediately.</p>
|
||||
<p><strong>NOTE:</strong> The <code>print!</code> macro will lock the standard output on each call. If you call
|
||||
<code>print!</code> within a hot loop, this behavior may be the bottleneck of the loop.
|
||||
To avoid this, lock stdout with <a href="struct.AutoStream.html#method.lock" title="method anstream::AutoStream::lock"><code>AutoStream::lock</code></a>:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::Write <span class="kw">as _</span>;
|
||||
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>lock = anstream::stdout().lock();
|
||||
<span class="macro">write!</span>(lock, <span class="string">"hello world"</span>).unwrap();</code></pre></div>
|
||||
<p>Use <code>print!</code> only for the primary output of your program. Use
|
||||
<a href="https://doc.rust-lang.org/1.84.1/std/macro.eprint.html" title="macro std::eprint"><code>eprint!</code></a> instead to print error and progress messages.</p>
|
||||
<p><strong>NOTE:</strong> Not all <code>print!</code> calls will be captured in tests like <a href="https://doc.rust-lang.org/1.84.1/std/macro.print.html" title="macro std::print"><code>std::print!</code></a></p>
|
||||
<ul>
|
||||
<li>Capturing will automatically be activated in test binaries</li>
|
||||
<li>Otherwise, only when the <code>test</code> feature is enabled</li>
|
||||
</ul>
|
||||
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||||
<p>Panics if writing to <code>stdout</code> fails for any reason <strong>except</strong> broken pipe.</p>
|
||||
<p>Writing to non-blocking stdout can cause an error, which will lead
|
||||
this macro to panic.</p>
|
||||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::Write <span class="kw">as _</span>;
|
||||
<span class="kw">use </span>anstream::print;
|
||||
<span class="kw">use </span>anstream::stdout;
|
||||
|
||||
<span class="macro">print!</span>(<span class="string">"this "</span>);
|
||||
<span class="macro">print!</span>(<span class="string">"will "</span>);
|
||||
<span class="macro">print!</span>(<span class="string">"be "</span>);
|
||||
<span class="macro">print!</span>(<span class="string">"on "</span>);
|
||||
<span class="macro">print!</span>(<span class="string">"the "</span>);
|
||||
<span class="macro">print!</span>(<span class="string">"same "</span>);
|
||||
<span class="macro">print!</span>(<span class="string">"line "</span>);
|
||||
|
||||
stdout().flush().unwrap();
|
||||
|
||||
<span class="macro">print!</span>(<span class="string">"this string has a newline, why not choose println! instead?\n"</span>);
|
||||
|
||||
stdout().flush().unwrap();</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
11
anstream/macro.println!.html
Normal file
11
anstream/macro.println!.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=macro.println.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="macro.println.html">macro.println.html</a>...</p>
|
||||
<script>location.replace("macro.println.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
36
anstream/macro.println.html
Normal file
36
anstream/macro.println.html
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
<!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="Prints to `stdout`, with a newline."><title>println in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">println</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Macro <span class="macro">println</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/_macros.rs.html#130-151">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! println {
|
||||
() => { ... };
|
||||
($($arg:tt)*) => { ... };
|
||||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Prints to <a href="fn.stdout.html" title="fn anstream::stdout"><code>stdout</code></a>, with a newline.</p>
|
||||
<p>On all platforms, the newline is the LINE FEED character (<code>\n</code>/<code>U+000A</code>) alone
|
||||
(no additional CARRIAGE RETURN (<code>\r</code>/<code>U+000D</code>)).</p>
|
||||
<p>This macro uses the same syntax as <a href="https://doc.rust-lang.org/1.84.1/alloc/macro.format.html" title="macro alloc::format"><code>format!</code></a>, but writes to the standard output instead.
|
||||
See <a href="https://doc.rust-lang.org/1.84.1/alloc/fmt/index.html" title="mod alloc::fmt"><code>std::fmt</code></a> for more information.</p>
|
||||
<p><strong>NOTE:</strong> The <code>println!</code> macro will lock the standard output on each call. If you call
|
||||
<code>println!</code> within a hot loop, this behavior may be the bottleneck of the loop.
|
||||
To avoid this, lock stdout with <a href="struct.AutoStream.html#method.lock" title="method anstream::AutoStream::lock"><code>AutoStream::lock</code></a>:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::Write <span class="kw">as _</span>;
|
||||
|
||||
<span class="kw">let </span><span class="kw-2">mut </span>lock = anstream::stdout().lock();
|
||||
<span class="macro">writeln!</span>(lock, <span class="string">"hello world"</span>).unwrap();</code></pre></div>
|
||||
<p>Use <code>println!</code> only for the primary output of your program. Use
|
||||
<a href="https://doc.rust-lang.org/1.84.1/std/macro.eprintln.html" title="macro std::eprintln"><code>eprintln!</code></a> instead to print error and progress messages.</p>
|
||||
<p><strong>NOTE:</strong> Not all <code>println!</code> calls will be captured in tests like <a href="https://doc.rust-lang.org/1.84.1/std/macro.println.html" title="macro std::println"><code>std::println!</code></a></p>
|
||||
<ul>
|
||||
<li>Capturing will automatically be activated in test binaries</li>
|
||||
<li>Otherwise, only when the <code>test</code> feature is enabled</li>
|
||||
</ul>
|
||||
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||||
<p>Panics if writing to <code>stdout</code> fails for any reason <strong>except</strong> broken pipe.</p>
|
||||
<p>Writing to non-blocking stdout can cause an error, which will lead
|
||||
this macro to panic.</p>
|
||||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>anstream::println;
|
||||
|
||||
<span class="macro">println!</span>(); <span class="comment">// prints just a newline
|
||||
</span><span class="macro">println!</span>(<span class="string">"hello there!"</span>);
|
||||
<span class="macro">println!</span>(<span class="string">"format {} arguments"</span>, <span class="string">"some"</span>);
|
||||
<span class="kw">let </span>local_variable = <span class="string">"some"</span>;
|
||||
<span class="macro">println!</span>(<span class="string">"format {local_variable} arguments"</span>);</code></pre></div>
|
||||
</div></details></section></div></main></body></html>
|
||||
1
anstream/sidebar-items.js
Normal file
1
anstream/sidebar-items.js
Normal file
|
|
@ -0,0 +1 @@
|
|||
window.SIDEBAR_ITEMS = {"enum":["ColorChoice"],"fn":["stderr","stdout"],"macro":["eprint","eprintln","panic","print","println"],"mod":["adapter","stream"],"struct":["AutoStream","StripStream"],"type":["Stderr","Stdout"]};
|
||||
2
anstream/stream/index.html
Normal file
2
anstream/stream/index.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!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="Higher-level traits to describe writeable streams"><title>anstream::stream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module stream</a></h2><h3><a href="#traits">Module Items</a></h3><ul class="block"><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">anstream</a></span><h1>Module <span>stream</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/anstream/stream.rs.html#1-315">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Higher-level traits to describe writeable streams</p>
|
||||
</div></details><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.AsLockedWrite.html" title="trait anstream::stream::AsLockedWrite">AsLocked<wbr>Write</a></div><div class="desc docblock-short">Lock a stream</div></li><li><div class="item-name"><a class="trait" href="trait.IsTerminal.html" title="trait anstream::stream::IsTerminal">IsTerminal</a></div><div class="desc docblock-short">Trait to determine if a descriptor/handle refers to a terminal/tty.</div></li><li><div class="item-name"><a class="trait" href="trait.RawStream.html" title="trait anstream::stream::RawStream">RawStream</a></div><div class="desc docblock-short">Required functionality for underlying <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write"><code>std::io::Write</code></a> for adaptation</div></li></ul></section></div></main></body></html>
|
||||
1
anstream/stream/sidebar-items.js
Normal file
1
anstream/stream/sidebar-items.js
Normal file
|
|
@ -0,0 +1 @@
|
|||
window.SIDEBAR_ITEMS = {"trait":["AsLockedWrite","IsTerminal","RawStream"]};
|
||||
16
anstream/stream/trait.AsLockedWrite.html
Normal file
16
anstream/stream/trait.AsLockedWrite.html
Normal file
File diff suppressed because one or more lines are too long
6
anstream/stream/trait.IsTerminal.html
Normal file
6
anstream/stream/trait.IsTerminal.html
Normal file
File diff suppressed because one or more lines are too long
5
anstream/stream/trait.RawStream.html
Normal file
5
anstream/stream/trait.RawStream.html
Normal file
File diff suppressed because one or more lines are too long
11
anstream/strip/struct.StripStream.html
Normal file
11
anstream/strip/struct.StripStream.html
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta http-equiv="refresh" content="0;URL=../../anstream/struct.StripStream.html">
|
||||
<title>Redirection</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Redirecting to <a href="../../anstream/struct.StripStream.html">../../anstream/struct.StripStream.html</a>...</p>
|
||||
<script>location.replace("../../anstream/struct.StripStream.html" + location.search + location.hash);</script>
|
||||
</body>
|
||||
</html>
|
||||
74
anstream/struct.AutoStream.html
Normal file
74
anstream/struct.AutoStream.html
Normal file
File diff suppressed because one or more lines are too long
42
anstream/struct.StripStream.html
Normal file
42
anstream/struct.StripStream.html
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
<!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="Only pass printable data to the inner `Write`"><title>StripStream in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Strip<wbr>Stream</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.into_inner" title="into_inner">into_inner</a></li><li><a href="#method.is_terminal" title="is_terminal">is_terminal</a></li><li><a href="#method.lock" title="lock">lock</a></li><li><a href="#method.lock-1" title="lock">lock</a></li><li><a href="#method.new" title="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-StripStream%3CS%3E" title="Debug">Debug</a></li><li><a href="#impl-Write-for-StripStream%3CS%3E" title="Write">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-StripStream%3CS%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-StripStream%3CS%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-StripStream%3CS%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-StripStream%3CS%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-StripStream%3CS%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-StripStream%3CS%3E" title="UnwindSafe">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" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Struct <span class="struct">StripStream</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/strip.rs.html#7-13">Source</a> </span></div><pre class="rust item-decl"><code>pub struct StripStream<S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write">Write</a>,</div>{ <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>Only pass printable data to the inner <code>Write</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-StripStream%3CS%3E" class="impl"><a class="src rightside" href="../src/anstream/strip.rs.html#15-33">Source</a><a href="#impl-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write">Write</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/strip.rs.html#21-26">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</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/strip.rs.html#30-32">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="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write"><code>std::io::Write</code></a></p>
|
||||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-StripStream%3CS%3E-1" class="impl"><a class="src rightside" href="../src/anstream/strip.rs.html#35-45">Source</a><a href="#impl-StripStream%3CS%3E-1" class="anchor">§</a><h3 class="code-header">impl<S> <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + <a class="trait" href="stream/trait.IsTerminal.html" title="trait anstream::stream::IsTerminal">IsTerminal</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.is_terminal" class="method"><a class="src rightside" href="../src/anstream/strip.rs.html#42-44">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.84.1/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></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-StripStream%3CStdout%3E" class="impl"><a class="src rightside" href="../src/anstream/strip.rs.html#47-60">Source</a><a href="#impl-StripStream%3CStdout%3E" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/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/strip.rs.html#54-59">Source</a><h4 class="code-header">pub fn <a href="#method.lock" class="fn">lock</a>(self) -> <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/stdio/struct.StdoutLock.html" title="struct std::io::stdio::StdoutLock">StdoutLock</a><'static>> <a href="#" class="tooltip" data-notable-ty="StripStream<StdoutLock<'static>>">ⓘ</a></h4></section></summary><div class="docblock"><p>Get exclusive access to the <code>StripStream</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-StripStream%3CStderr%3E" class="impl"><a class="src rightside" href="../src/anstream/strip.rs.html#62-75">Source</a><a href="#impl-StripStream%3CStderr%3E" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/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/strip.rs.html#69-74">Source</a><h4 class="code-header">pub fn <a href="#method.lock-1" class="fn">lock</a>(self) -> <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/stdio/struct.StderrLock.html" title="struct std::io::stdio::StderrLock">StderrLock</a><'static>> <a href="#" class="tooltip" data-notable-ty="StripStream<StderrLock<'static>>">ⓘ</a></h4></section></summary><div class="docblock"><p>Get exclusive access to the <code>StripStream</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-StripStream%3CS%3E" class="impl"><a class="src rightside" href="../src/anstream/strip.rs.html#6">Source</a><a href="#impl-Debug-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write">Write</a> + <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</div></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/strip.rs.html#6">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/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.84.1/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-StripStream%3CS%3E" class="impl"><a class="src rightside" href="../src/anstream/strip.rs.html#77-110">Source</a><a href="#impl-Write-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html" title="trait std::io::Write">Write</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/strip.rs.html#84-86">Source</a><a href="#method.write" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html#tymethod.write" class="fn">write</a>(&mut self, buf: &[<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.u8.html">u8</a>]) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>></h4></section></summary><div class='docblock'>Writes a buffer into this writer, returning how many bytes were written. <a href="https://doc.rust-lang.org/1.84.1/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/strip.rs.html#88-95">Source</a><a href="#method.write_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/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.84.1/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'_>]) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.usize.html">usize</a>></h4></section></summary><div class='docblock'>Like <a href="https://doc.rust-lang.org/1.84.1/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.84.1/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/strip.rs.html#98-100">Source</a><a href="#method.flush" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html#tymethod.flush" class="fn">flush</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>></h4></section></summary><div class='docblock'>Flushes this output stream, ensuring that all intermediately buffered
|
||||
contents reach their destination. <a href="https://doc.rust-lang.org/1.84.1/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/strip.rs.html#102-104">Source</a><a href="#method.write_all" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/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.84.1/std/primitive.u8.html">u8</a>]) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/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.84.1/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/strip.rs.html#107-109">Source</a><a href="#method.write_fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/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.84.1/core/fmt/struct.Arguments.html" title="struct core::fmt::Arguments">Arguments</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/src/std/io/mod.rs.html#1686">Source</a><a href="#method.is_write_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/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.84.1/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.84.1/src/std/io/mod.rs.html#1810">Source</a><a href="#method.write_all_vectored" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/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.84.1/std/io/struct.IoSlice.html" title="struct std::io::IoSlice">IoSlice</a><'_>]) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/src/std/io/mod.rs.html#1923-1925">Source</a></span><a href="#method.by_ref" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html#method.by_ref" class="fn">by_ref</a>(&mut self) -> &mut Self<div class="where">where
|
||||
Self: <a class="trait" href="https://doc.rust-lang.org/1.84.1/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.84.1/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-StripStream%3CS%3E" class="impl"><a href="#impl-Freeze-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-StripStream%3CS%3E" class="impl"><a href="#impl-RefUnwindSafe-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-StripStream%3CS%3E" class="impl"><a href="#impl-Send-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-StripStream%3CS%3E" class="impl"><a href="#impl-Sync-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-StripStream%3CS%3E" class="impl"><a href="#impl-Unpin-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-StripStream%3CS%3E" class="impl"><a href="#impl-UnwindSafe-for-StripStream%3CS%3E" class="anchor">§</a><h3 class="code-header">impl<S> <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.StripStream.html" title="struct anstream::StripStream">StripStream</a><S><div class="where">where
|
||||
S: <a class="trait" href="https://doc.rust-lang.org/1.84.1/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.84.1/src/core/any.rs.html#138">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.84.1/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.84.1/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.84.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/src/core/borrow.rs.html#209">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.84.1/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.84.1/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.84.1/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/src/core/borrow.rs.html#217">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.84.1/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.84.1/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.84.1/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/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.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||||
</div></details></div></details><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.84.1/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.84.1/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.84.1/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-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/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.84.1/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.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/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.84.1/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" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/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.84.1/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.84.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.1/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.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/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">{"StripStream<StderrLock<'static>>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.StripStream.html\" title=\"struct anstream::StripStream\">StripStream</a><S></code></h3><pre><code><div class=\"where\">impl<S> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"struct.StripStream.html\" title=\"struct anstream::StripStream\">StripStream</a><S><div class=\"where\">where\n S: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> + <a class=\"trait\" href=\"stream/trait.AsLockedWrite.html\" title=\"trait anstream::stream::AsLockedWrite\">AsLockedWrite</a>,</div></div>","StripStream<StdoutLock<'static>>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.StripStream.html\" title=\"struct anstream::StripStream\">StripStream</a><S></code></h3><pre><code><div class=\"where\">impl<S> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"struct.StripStream.html\" title=\"struct anstream::StripStream\">StripStream</a><S><div class=\"where\">where\n S: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.1/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> + <a class=\"trait\" href=\"stream/trait.AsLockedWrite.html\" title=\"trait anstream::stream::AsLockedWrite\">AsLockedWrite</a>,</div></div>"}</script></section></div></main></body></html>
|
||||
2
anstream/type.Stderr.html
Normal file
2
anstream/type.Stderr.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!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="An adaptive wrapper around the global standard error stream of the current process"><title>Stderr in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Stderr</a></h2><h3><a href="#aliased-type">Aliased type</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Type Alias <span class="type">Stderr</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/lib.rs.html#63">Source</a> </span></div><pre class="rust item-decl"><code>pub type Stderr = <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/stdio/struct.Stderr.html" title="struct std::io::stdio::Stderr">Stderr</a>>;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An adaptive wrapper around the global standard error stream of the current process</p>
|
||||
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct Stderr { <span class="comment">/* private fields */</span> }</code></pre><script src="../type.impl/anstream/struct.AutoStream.js" data-self-path="anstream::Stderr" async></script></section></div></main></body></html>
|
||||
2
anstream/type.Stdout.html
Normal file
2
anstream/type.Stdout.html
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
<!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="An adaptive wrapper around the global standard output stream of the current process"><title>Stdout in anstream - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[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.18</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Stdout</a></h2><h3><a href="#aliased-type">Aliased type</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate anstream</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">anstream</a></span><h1>Type Alias <span class="type">Stdout</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/anstream/lib.rs.html#61">Source</a> </span></div><pre class="rust item-decl"><code>pub type Stdout = <a class="struct" href="struct.AutoStream.html" title="struct anstream::AutoStream">AutoStream</a><<a class="struct" href="https://doc.rust-lang.org/1.84.1/std/io/stdio/struct.Stdout.html" title="struct std::io::stdio::Stdout">Stdout</a>>;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An adaptive wrapper around the global standard output stream of the current process</p>
|
||||
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>struct Stdout { <span class="comment">/* private fields */</span> }</code></pre><script src="../type.impl/anstream/struct.AutoStream.js" data-self-path="anstream::Stdout" async></script></section></div></main></body></html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue