edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-14 20:18:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/anstream/adapter/fn.strip_bytes.html

11 lines
6 KiB
HTML
Raw Normal View History

deploy: c568cd4876f87c92ab3102b3735a83cf3fe832f2
2024-04-13 08:42:00 +00:00
<!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-5bc39a1768837dd0.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.77.2 (25ef9e3d8 2024-04-09)" data-channel="1.77.2" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.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" 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"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../anstream/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>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.77.2/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>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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>
deploy: 39fc7f2b9fd58ce67982b1c71c788f3b031ae3df
2024-03-27 11:12:16 +00:00
<h2 id="example"><a class="doc-anchor" href="#example">§</a>Example</h2>
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
<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">&amp;</span><span class="string">b"foo bar"</span>[..]);</code></pre></div>
deploy: c568cd4876f87c92ab3102b3735a83cf3fe832f2
2024-04-13 08:42:00 +00:00
</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.77.2/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.77.2/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.77.2/std/primitive.u8.html\">u8</a>];</div>"}</script></section></div></main></body></html>
Reference in a new issue Copy permalink