<!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="API documentation for the Rust `escape_default` fn in crate `std`."><meta name="keywords" content="rust, rustlang, rust-lang, escape_default"><title>std::ascii::escape_default - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://doc.rust-lang.org/favicon.ico"></head><body class="rustdoc fn"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../std/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a><div class="sidebar-elems"><p class='location'><a href='../index.html'>std</a>::<wbr><a href='index.html'>ascii</a></p><script>window.sidebarCurrent = {name: 'escape_default', ty: 'fn', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Function <a href='../index.html'>std</a>::<wbr><a href='index.html'>ascii</a>::<wbr><a class="fn" href=''>escape_default</a></span><span class='out-of-band'><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/core/ascii.rs.html#103-123' title='goto source code'>[src]</a></span></h1><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../std/ascii/struct.EscapeDefault.html" title="struct std::ascii::EscapeDefault">EscapeDefault</a></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../std/ascii/struct.EscapeDefault.html" title="struct std::ascii::EscapeDefault">EscapeDefault</a></h3><code class="content"><span class="where fmt-newline">impl <a class="trait" href="../../std/iter/trait.Iterator.html" title="trait std::iter::Iterator">Iterator</a> for <a class="struct" href="../../std/ascii/struct.EscapeDefault.html" title="struct std::ascii::EscapeDefault">EscapeDefault</a></span><span class="where fmt-newline"> type <a href='../../std/iter/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="../primitive.u8.html">u8</a>;</span></code></div></div><pre class='rust fn'>pub fn escape_default(c: <a class="primitive" href="../primitive.u8.html">u8</a>) -> <a class="struct" href="../../std/ascii/struct.EscapeDefault.html" title="struct std::ascii::EscapeDefault">EscapeDefault</a></pre><div class='docblock'><p>Returns an iterator that produces an escaped version of a <code>u8</code>.</p>
<p>The default is chosen with a bias toward producing literals that are
legal in a variety of languages, including C++11 and similar C-family
languages. The exact rules are:</p>
<ul>
<li>Tab is escaped as <code>\t</code>.</li>
<li>Carriage return is escaped as <code>\r</code>.</li>
<li>Line feed is escaped as <code>\n</code>.</li>
<li>Single quote is escaped as <code>\'</code>.</li>
<li>Double quote is escaped as <code>\"</code>.</li>
<li>Backslash is escaped as <code>\\</code>.</li>
<li>Any character in the 'printable ASCII' range <code>0x20</code> .. <code>0x7e</code>
inclusive is not escaped.</li>
<li>Any other chars are given hex escapes of the form '\xNN'.</li>
<li>Unicode escapes are never generated by this function.</li>
</ul>
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ascii</span>;
<span class="kw">let</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'0'</span>).<span class="ident">next</span>().<span class="ident">unwrap</span>();
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'0'</span>, <span class="ident">escaped</span>);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'\t'</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b't'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'\r'</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'r'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'\n'</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'n'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'\''</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\''</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'"'</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'"'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'\\'</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">escaped</span> <span class="op">=</span> <span class="ident">ascii</span>::<span class="ident">escape_default</span>(<span class="string">b'\x9d'</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'\\'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'x'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'9'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">b'd'</span>, <span class="ident">escaped</span>.<span class="ident">next</span>().<span class="ident">unwrap</span>());<a class="test-arrow" target="_blank" href="https://play.rust-lang.org/?code=%23!%5Ballow(unused)%5D%0Afn%20main()%20%7B%0Ause%20std%3A%3Aascii%3B%0A%0Alet%20escaped%20%3D%20ascii%3A%3Aescape_default(b'0').next().unwrap()%3B%0Aassert_eq!(b'0'%2C%20escaped)%3B%0A%0Alet%20mut%20escaped%20%3D%20ascii%3A%3Aescape_default(b'%5Ct')%3B%0A%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b't'%2C%20escaped.next().unwrap())%3B%0A%0Alet%20mut%20escaped%20%3D%20ascii%3A%3Aescape_default(b'%5Cr')%3B%0A%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'r'%2C%20escaped.next().unwrap())%3B%0A%0Alet%20mut%20escaped%20%3D%20ascii%3A%3Aescape_default(b'%5Cn')%3B%0A%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'n'%2C%20escaped.next().unwrap())%3B%0A%0Alet%20mut%20escaped%20%3D%20ascii%3A%3Aescape_default(b'%5C'')%3B%0A%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'%5C''%2C%20escaped.next().unwrap())%3B%0A%0Alet%20mut%20escaped%20%3D%20ascii%3A%3Aescape_default(b'%22')%3B%0A%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'%22'%2C%20escaped.next().unwrap())%3B%0A%0Alet%20mut%20escaped%20%3D%20ascii%3A%3Aescape_default(b'%5C%5C')%3B%0A%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0A%0Alet%20mut%20escaped%20%3D%20ascii%3A%3Aescape_default(b'%5Cx9d')%3B%0A%0Aassert_eq!(b'%5C%5C'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'x'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'9'%2C%20escaped.next().unwrap())%3B%0Aassert_eq!(b'd'%2C%20escaped.next().unwrap())%3B%0A%7D">Run</a></pre>
</div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "std";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
4e2dbb669434a7691662cb2f0ad38972
>
files
>
12010
