Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fraterenz committed Aug 21, 2024
1 parent d604fd7 commit 8c1e414
Show file tree
Hide file tree
Showing 8,315 changed files with 109,345 additions and 117,486 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
10 changes: 5 additions & 5 deletions docs/anstream/adapter/fn.strip_bytes.html
Original file line number Diff line number Diff line change
@@ -1,10 +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><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-9ee3a5e31a2afa3e.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.75.0 (82e1608df 2023-12-21)" data-channel="1.75.0" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc 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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../anstream/index.html">anstream</a><span class="version">0.6.13</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In anstream::adapter</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">anstream</a>::<wbr><a href="index.html">adapter</a>::<wbr><a class="fn" href="#">strip_bytes</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/anstream/adapter/strip.rs.html#176-178">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn strip_bytes(data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.75.0/std/primitive.u8.html">u8</a>]) -&gt; <a class="struct" href="struct.StrippedBytes.html" title="struct anstream::adapter::StrippedBytes">StrippedBytes</a>&lt;'_&gt; <a href="#" class="tooltip" data-notable-ty="StrippedBytes&lt;&#39;_&gt;"></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>
<!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-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="anstream" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.1 (3f5fd8dd4 2024-08-06)" data-channel="1.80.1" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc 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.13</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In anstream::adapter</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">anstream</a>::<wbr><a href="index.html">adapter</a>::<wbr><a class="fn" href="#">strip_bytes</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/anstream/adapter/strip.rs.html#176-178">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub fn strip_bytes(data: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.80.1/std/primitive.u8.html">u8</a>]) -&gt; <a class="struct" href="struct.StrippedBytes.html" title="struct anstream::adapter::StrippedBytes">StrippedBytes</a>&lt;'_&gt; <a href="#" class="tooltip" data-notable-ty="StrippedBytes&lt;&#39;_&gt;"></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 href="#example">Example</a></h2>
<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">&quot;\x1b[32mfoo\x1b[m bar&quot;</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">&amp;</span><span class="string">b&quot;foo bar&quot;</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>&lt;'s&gt;</code></h3><pre><code><span class=\"where fmt-newline\">impl&lt;'s&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.75.0/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>&lt;'s&gt;</span><span class=\"where fmt-newline\"> type <a href=\"https://doc.rust-lang.org/1.75.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = &amp;'s [<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.75.0/std/primitive.u8.html\">u8</a>];</span>"}</script></section></div></main></body></html>
<span class="macro">assert_eq!</span>(plain_str.as_slice(), <span class="kw-2">&amp;</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>&lt;'s&gt;</code></h3><pre><code><div class=\"where\">impl&lt;'s&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.80.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>&lt;'s&gt;</div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.80.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = &amp;'s [<a class=\"primitive\" href=\"https://doc.rust-lang.org/1.80.1/std/primitive.u8.html\">u8</a>];</div>"}</script></section></div></main></body></html>
Loading

0 comments on commit 8c1e414

Please sign in to comment.