mentat/serde_json/map/index.html

213 lines
9.6 KiB
HTML
Raw 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 `map` mod in crate `serde_json`.">
<meta name="keywords" content="rust, rustlang, rust-lang, map">
<title>serde_json::map - 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 map</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>serde_json</a></p><script>window.sidebarCurrent = {name: 'map', 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=''>map</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/map.rs.html#9-852' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>A map of String to serde_json::Value.</p>
<p>By default the map is backed by a <a href="https://doc.rust-lang.org/std/collections/struct.BTreeMap.html"><code>BTreeMap</code></a>. Enable the <code>preserve_order</code>
feature of serde_json to use <a href="https://docs.rs/indexmap/*/indexmap/map/struct.IndexMap.html"><code>IndexMap</code></a> instead.</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.IntoIter.html"
title='struct serde_json::map::IntoIter'>IntoIter</a></td>
<td class='docblock-short'>
<p>An owning iterator over a serde_json::Map's entries.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Iter.html"
title='struct serde_json::map::Iter'>Iter</a></td>
<td class='docblock-short'>
<p>An iterator over a serde_json::Map's entries.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.IterMut.html"
title='struct serde_json::map::IterMut'>IterMut</a></td>
<td class='docblock-short'>
<p>A mutable iterator over a serde_json::Map's entries.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Keys.html"
title='struct serde_json::map::Keys'>Keys</a></td>
<td class='docblock-short'>
<p>An iterator over a serde_json::Map's keys.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Map.html"
title='struct serde_json::map::Map'>Map</a></td>
<td class='docblock-short'>
<p>Represents a JSON key/value type.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.OccupiedEntry.html"
title='struct serde_json::map::OccupiedEntry'>OccupiedEntry</a></td>
<td class='docblock-short'>
<p>An occupied Entry. It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.VacantEntry.html"
title='struct serde_json::map::VacantEntry'>VacantEntry</a></td>
<td class='docblock-short'>
<p>A vacant Entry. It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.Values.html"
title='struct serde_json::map::Values'>Values</a></td>
<td class='docblock-short'>
<p>An iterator over a serde_json::Map's values.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class="struct" href="struct.ValuesMut.html"
title='struct serde_json::map::ValuesMut'>ValuesMut</a></td>
<td class='docblock-short'>
<p>A mutable iterator over a serde_json::Map's values.</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.Entry.html"
title='enum serde_json::map::Entry'>Entry</a></td>
<td class='docblock-short'>
<p>A view into a single entry in a map, which may either be vacant or occupied.
This enum is constructed from the <a href="struct.Map.html#method.entry"><code>entry</code></a> method on <a href="struct.Map.html"><code>Map</code></a>.</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>