mentat/serde_json/ser/index.html
2018-08-22 17:04:13 +00:00

222 lines
No EOL
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `ser` mod in crate `serde_json`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ser">
<title>serde_json::ser - 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 mod">
<!--[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'>Module ser</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>serde_json</a></p><script>window.sidebarCurrent = {name: 'ser', ty: 'mod', 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'>Module <a href='../index.html'>serde_json</a>::<wbr><a class="mod" href=''>ser</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#9-2096' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Serialize a Rust data structure into JSON data.</p>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class="struct" href="struct.CompactFormatter.html"
title='struct serde_json::ser::CompactFormatter'>CompactFormatter</a></td>
<td class='docblock-short'>
<p>This structure compacts a JSON value with no extra whitespace.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.PrettyFormatter.html"
title='struct serde_json::ser::PrettyFormatter'>PrettyFormatter</a></td>
<td class='docblock-short'>
<p>This structure pretty prints a JSON value to make it human readable.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Serializer.html"
title='struct serde_json::ser::Serializer'>Serializer</a></td>
<td class='docblock-short'>
<p>A structure for serializing Rust values into JSON.</p>
</td>
</tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table>
<tr class=' module-item'>
<td><a class="enum" href="enum.CharEscape.html"
title='enum serde_json::ser::CharEscape'>CharEscape</a></td>
<td class='docblock-short'>
<p>Represents a character escape code in a type-safe manner.</p>
</td>
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table>
<tr class=' module-item'>
<td><a class="trait" href="trait.Formatter.html"
title='trait serde_json::ser::Formatter'>Formatter</a></td>
<td class='docblock-short'>
<p>This trait abstracts away serializing the JSON control characters, which allows the user to
optionally pretty print the JSON output.</p>
</td>
</tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table>
<tr class=' module-item'>
<td><a class="fn" href="fn.to_string.html"
title='fn serde_json::ser::to_string'>to_string</a></td>
<td class='docblock-short'>
<p>Serialize the given data structure as a String of JSON.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.to_string_pretty.html"
title='fn serde_json::ser::to_string_pretty'>to_string_pretty</a></td>
<td class='docblock-short'>
<p>Serialize the given data structure as a pretty-printed String of JSON.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.to_vec.html"
title='fn serde_json::ser::to_vec'>to_vec</a></td>
<td class='docblock-short'>
<p>Serialize the given data structure as a JSON byte vector.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.to_vec_pretty.html"
title='fn serde_json::ser::to_vec_pretty'>to_vec_pretty</a></td>
<td class='docblock-short'>
<p>Serialize the given data structure as a pretty-printed JSON byte vector.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.to_writer.html"
title='fn serde_json::ser::to_writer'>to_writer</a></td>
<td class='docblock-short'>
<p>Serialize the given data structure as JSON into the IO stream.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="fn" href="fn.to_writer_pretty.html"
title='fn serde_json::ser::to_writer_pretty'>to_writer_pretty</a></td>
<td class='docblock-short'>
<p>Serialize the given data structure as pretty-printed JSON into the IO
stream.</p>
</td>
</tr></table></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>