mentat/serde_json/ser/enum.CharEscape.html

150 lines
8.4 KiB
HTML
Raw Permalink Normal View History

2018-08-22 17:04:13 +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="API documentation for the Rust `CharEscape` enum in crate `serde_json`.">
<meta name="keywords" content="rust, rustlang, rust-lang, CharEscape">
<title>serde_json::ser::CharEscape - 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="../../main.css" id="themeStyle">
<script src="../../storage.js"></script>
</head>
<body class="rustdoc enum">
<!--[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">&#9776;</div>
<p class='location'>Enum CharEscape</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Quote">Quote</a><a href="#variant.ReverseSolidus">ReverseSolidus</a><a href="#variant.Solidus">Solidus</a><a href="#variant.Backspace">Backspace</a><a href="#variant.FormFeed">FormFeed</a><a href="#variant.LineFeed">LineFeed</a><a href="#variant.CarriageReturn">CarriageReturn</a><a href="#variant.Tab">Tab</a><a href="#variant.AsciiControl">AsciiControl</a></div></div><p class='location'><a href='../index.html'>serde_json</a>::<wbr><a href='index.html'>ser</a></p><script>window.sidebarCurrent = {name: 'CharEscape', ty: 'enum', 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">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Enum <a href='../index.html'>serde_json</a>::<wbr><a href='index.html'>ser</a>::<wbr><a class="enum" href=''>CharEscape</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../../src/serde_json/ser.rs.html#1414-1434' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum CharEscape {
Quote,
ReverseSolidus,
Solidus,
Backspace,
FormFeed,
LineFeed,
CarriageReturn,
Tab,
AsciiControl(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>),
}</pre><div class='docblock'><p>Represents a character escape code in a type-safe manner.</p>
</div><h2 id='variants' class='variants small-section-header'>
Variants<a href='#variants' class='anchor'></a></h2>
<span id="variant.Quote" class="variant small-section-header"><a href="#variant.Quote" class="anchor field"></a><span id='Quote.v' class='invisible'><code>Quote</code></span></span><div class='docblock'><p>An escaped quote <code>&quot;</code></p>
</div><span id="variant.ReverseSolidus" class="variant small-section-header"><a href="#variant.ReverseSolidus" class="anchor field"></a><span id='ReverseSolidus.v' class='invisible'><code>ReverseSolidus</code></span></span><div class='docblock'><p>An escaped reverse solidus <code>\</code></p>
</div><span id="variant.Solidus" class="variant small-section-header"><a href="#variant.Solidus" class="anchor field"></a><span id='Solidus.v' class='invisible'><code>Solidus</code></span></span><div class='docblock'><p>An escaped solidus <code>/</code></p>
</div><span id="variant.Backspace" class="variant small-section-header"><a href="#variant.Backspace" class="anchor field"></a><span id='Backspace.v' class='invisible'><code>Backspace</code></span></span><div class='docblock'><p>An escaped backspace character (usually escaped as <code>\b</code>)</p>
</div><span id="variant.FormFeed" class="variant small-section-header"><a href="#variant.FormFeed" class="anchor field"></a><span id='FormFeed.v' class='invisible'><code>FormFeed</code></span></span><div class='docblock'><p>An escaped form feed character (usually escaped as <code>\f</code>)</p>
</div><span id="variant.LineFeed" class="variant small-section-header"><a href="#variant.LineFeed" class="anchor field"></a><span id='LineFeed.v' class='invisible'><code>LineFeed</code></span></span><div class='docblock'><p>An escaped line feed character (usually escaped as <code>\n</code>)</p>
</div><span id="variant.CarriageReturn" class="variant small-section-header"><a href="#variant.CarriageReturn" class="anchor field"></a><span id='CarriageReturn.v' class='invisible'><code>CarriageReturn</code></span></span><div class='docblock'><p>An escaped carriage return character (usually escaped as <code>\r</code>)</p>
</div><span id="variant.Tab" class="variant small-section-header"><a href="#variant.Tab" class="anchor field"></a><span id='Tab.v' class='invisible'><code>Tab</code></span></span><div class='docblock'><p>An escaped tab character (usually escaped as <code>\t</code>)</p>
</div><span id="variant.AsciiControl" class="variant small-section-header"><a href="#variant.AsciiControl" class="anchor field"></a><span id='AsciiControl.v' class='invisible'><code>AsciiControl(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></span></span><div class='docblock'><p>An escaped ASCII plane control character (usually escaped as
<code>\u00XX</code> where <code>XX</code> are two hex characters)</p>
</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>&#9166;</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "serde_json";
</script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>