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

219 lines
No EOL
9.6 KiB
HTML
Raw Permalink 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 `rustc_serialize` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, rustc_serialize">
<title>rustc_serialize - 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>
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</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>
<a href='../rustc_serialize/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png' alt='logo' width='100'></a>
<p class='location'>Crate rustc_serialize</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'rustc_serialize', ty: 'mod', relpath: '../'};</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'>Crate <a class="mod" href=''>rustc_serialize</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/rustc_serialize/lib.rs.html#11-79' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>Support code for encoding and decoding types.</p>
<blockquote>
<p><strong>NOTE</strong>: This crate is deprecated in favor of <a href="https://serde.rs"><code>serde</code></a>. No new feature
development will happen in this crate, although bug fixes proposed through
PRs will still be merged. It is very highly recommended by the Rust
Library Team that you use <a href="https://serde.rs"><code>serde</code></a>, not this crate.</p>
</blockquote>
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
<p>This crate is <a href="https://crates.io/crates/rustc-serialize">on crates.io</a> and
can be used by adding <code>rustc-serialize</code> to the dependencies in your
project's <code>Cargo.toml</code>.</p>
<pre><code class="language-toml">[dependencies]
rustc-serialize = &quot;0.3&quot;
</code></pre>
<p>and this to your crate root:</p>
<pre class="rust rust-example-rendered">
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">rustc_serialize</span>;</pre>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table>
<tr class=' module-item'>
<td><a class="mod" href="base64/index.html"
title='mod rustc_serialize::base64'>base64</a></td>
<td class='docblock-short'>
<p>Base64 binary-to-text encoding</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="hex/index.html"
title='mod rustc_serialize::hex'>hex</a></td>
<td class='docblock-short'>
<p>Hex binary-to-text encoding</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="mod" href="json/index.html"
title='mod rustc_serialize::json'>json</a></td>
<td class='docblock-short'>
<p>JSON parsing and serialization</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.Decodable.html"
title='trait rustc_serialize::Decodable'>Decodable</a></td>
<td class='docblock-short'>
<p>Trait for deserializing a type.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.Decoder.html"
title='trait rustc_serialize::Decoder'>Decoder</a></td>
<td class='docblock-short'>
<p>Trait for reading in an encoding for deserialization.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.DecoderHelpers.html"
title='trait rustc_serialize::DecoderHelpers'>DecoderHelpers</a></td>
<td class='docblock-short'>
<p>Trait with helper functions for implementing <code>Decodable</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.Encodable.html"
title='trait rustc_serialize::Encodable'>Encodable</a></td>
<td class='docblock-short'>
<p>Trait for serializing a type.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.Encoder.html"
title='trait rustc_serialize::Encoder'>Encoder</a></td>
<td class='docblock-short'>
<p>Trait for writing out an encoding when serializing.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="trait" href="trait.EncoderHelpers.html"
title='trait rustc_serialize::EncoderHelpers'>EncoderHelpers</a></td>
<td class='docblock-short'>
<p>Trait with helper functions for implementing <code>Encodable</code>.</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 = "rustc_serialize";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>