mentat/serde_json/map/struct.OccupiedEntry.html
2018-08-22 17:04:13 +00:00

229 lines
No EOL
18 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 `OccupiedEntry` struct in crate `serde_json`.">
<meta name="keywords" content="rust, rustlang, rust-lang, OccupiedEntry">
<title>serde_json::map::OccupiedEntry - 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 struct">
<!--[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'>Struct OccupiedEntry</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.key">key</a><a href="#method.get">get</a><a href="#method.get_mut">get_mut</a><a href="#method.into_mut">into_mut</a><a href="#method.insert">insert</a><a href="#method.remove">remove</a></div></div><p class='location'><a href='../index.html'>serde_json</a>::<wbr><a href='index.html'>map</a></p><script>window.sidebarCurrent = {name: 'OccupiedEntry', ty: 'struct', 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'>Struct <a href='../index.html'>serde_json</a>::<wbr><a href='index.html'>map</a>::<wbr><a class="struct" href=''>OccupiedEntry</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#435-437' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct OccupiedEntry&lt;'a&gt; { /* fields omitted */ }</pre><div class='docblock'><p>An occupied Entry. It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</p>
</div>
<h2 id='methods' class='small-section-header'>
Methods<a href='#methods' class='anchor'></a>
</h2>
<h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class="struct" href="../../serde_json/map/struct.OccupiedEntry.html" title="struct serde_json::map::OccupiedEntry">OccupiedEntry</a>&lt;'a&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/map.rs.html#567-735' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.key' class="method"><span id='key.v' class='invisible'><code>pub fn <a href='#method.key' class='fnname'>key</a>(&amp;self) -&gt; &amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/map.rs.html#591-593' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Gets a reference to the key in the entry.</p>
<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">serde_json</span>::<span class="ident">map</span>::<span class="ident">Entry</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">Map</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">&quot;serde&quot;</span>.<span class="ident">to_owned</span>(), <span class="macro">json</span><span class="macro">!</span>(<span class="number">12</span>));
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">&quot;serde&quot;</span>) {
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">occupied</span>) <span class="op">=&gt;</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">occupied</span>.<span class="ident">key</span>(), <span class="kw-2">&amp;</span><span class="string">&quot;serde&quot;</span>);
}
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(_) <span class="op">=&gt;</span> <span class="macro">unimplemented</span><span class="macro">!</span>(),
}</pre>
</div><h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>pub fn <a href='#method.get' class='fnname'>get</a>(&amp;self) -&gt; &amp;<a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/map.rs.html#618-620' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Gets a reference to the value in the entry.</p>
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">serde_json</span>::<span class="ident">map</span>::<span class="ident">Entry</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">Map</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">&quot;serde&quot;</span>.<span class="ident">to_owned</span>(), <span class="macro">json</span><span class="macro">!</span>(<span class="number">12</span>));
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">&quot;serde&quot;</span>) {
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">occupied</span>) <span class="op">=&gt;</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">occupied</span>.<span class="ident">get</span>(), <span class="number">12</span>);
}
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(_) <span class="op">=&gt;</span> <span class="macro">unimplemented</span><span class="macro">!</span>(),
}</pre>
</div><h4 id='method.get_mut' class="method"><span id='get_mut.v' class='invisible'><code>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&amp;mut self) -&gt; &amp;mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/map.rs.html#647-649' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Gets a mutable reference to the value in the entry.</p>
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">serde_json</span>::<span class="ident">map</span>::<span class="ident">Entry</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">Map</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">&quot;serde&quot;</span>.<span class="ident">to_owned</span>(), <span class="macro">json</span><span class="macro">!</span>([<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]));
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">&quot;serde&quot;</span>) {
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="kw-2">mut</span> <span class="ident">occupied</span>) <span class="op">=&gt;</span> {
<span class="ident">occupied</span>.<span class="ident">get_mut</span>().<span class="ident">as_array_mut</span>().<span class="ident">unwrap</span>().<span class="ident">push</span>(<span class="macro">json</span><span class="macro">!</span>(<span class="number">4</span>));
}
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(_) <span class="op">=&gt;</span> <span class="macro">unimplemented</span><span class="macro">!</span>(),
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">&quot;serde&quot;</span>].<span class="ident">as_array</span>().<span class="ident">unwrap</span>().<span class="ident">len</span>(), <span class="number">4</span>);</pre>
</div><h4 id='method.into_mut' class="method"><span id='into_mut.v' class='invisible'><code>pub fn <a href='#method.into_mut' class='fnname'>into_mut</a>(self) -&gt; &amp;'a mut <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/map.rs.html#676-678' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Converts the entry into a mutable reference to its value.</p>
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">serde_json</span>::<span class="ident">map</span>::<span class="ident">Entry</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">Map</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">&quot;serde&quot;</span>.<span class="ident">to_owned</span>(), <span class="macro">json</span><span class="macro">!</span>([<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]));
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">&quot;serde&quot;</span>) {
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="kw-2">mut</span> <span class="ident">occupied</span>) <span class="op">=&gt;</span> {
<span class="ident">occupied</span>.<span class="ident">into_mut</span>().<span class="ident">as_array_mut</span>().<span class="ident">unwrap</span>().<span class="ident">push</span>(<span class="macro">json</span><span class="macro">!</span>(<span class="number">4</span>));
}
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(_) <span class="op">=&gt;</span> <span class="macro">unimplemented</span><span class="macro">!</span>(),
}
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">map</span>[<span class="string">&quot;serde&quot;</span>].<span class="ident">as_array</span>().<span class="ident">unwrap</span>().<span class="ident">len</span>(), <span class="number">4</span>);</pre>
</div><h4 id='method.insert' class="method"><span id='insert.v' class='invisible'><code>pub fn <a href='#method.insert' class='fnname'>insert</a>(&amp;mut self, value: <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a>) -&gt; <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/map.rs.html#705-707' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Sets the value of the entry with the <code>OccupiedEntry</code>'s key, and returns
the entry's old value.</p>
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">serde_json</span>::<span class="ident">map</span>::<span class="ident">Entry</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">Map</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">&quot;serde&quot;</span>.<span class="ident">to_owned</span>(), <span class="macro">json</span><span class="macro">!</span>(<span class="number">12</span>));
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">&quot;serde&quot;</span>) {
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="kw-2">mut</span> <span class="ident">occupied</span>) <span class="op">=&gt;</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">occupied</span>.<span class="ident">insert</span>(<span class="macro">json</span><span class="macro">!</span>(<span class="number">13</span>)), <span class="number">12</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">occupied</span>.<span class="ident">get</span>(), <span class="number">13</span>);
}
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(_) <span class="op">=&gt;</span> <span class="macro">unimplemented</span><span class="macro">!</span>(),
}</pre>
</div><h4 id='method.remove' class="method"><span id='remove.v' class='invisible'><code>pub fn <a href='#method.remove' class='fnname'>remove</a>(self) -&gt; <a class="enum" href="../../serde_json/value/enum.Value.html" title="enum serde_json::value::Value">Value</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/serde_json/map.rs.html#732-734' title='goto source code'>[src]</a></span></h4>
<div class='docblock'><p>Takes the value of the entry out of the map, and returns it.</p>
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
<pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">serde_json</span>::<span class="ident">map</span>::<span class="ident">Entry</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">map</span> <span class="op">=</span> <span class="ident">serde_json</span>::<span class="ident">Map</span>::<span class="ident">new</span>();
<span class="ident">map</span>.<span class="ident">insert</span>(<span class="string">&quot;serde&quot;</span>.<span class="ident">to_owned</span>(), <span class="macro">json</span><span class="macro">!</span>(<span class="number">12</span>));
<span class="kw">match</span> <span class="ident">map</span>.<span class="ident">entry</span>(<span class="string">&quot;serde&quot;</span>) {
<span class="ident">Entry</span>::<span class="ident">Occupied</span>(<span class="ident">occupied</span>) <span class="op">=&gt;</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">occupied</span>.<span class="ident">remove</span>(), <span class="number">12</span>);
}
<span class="ident">Entry</span>::<span class="ident">Vacant</span>(_) <span class="op">=&gt;</span> <span class="macro">unimplemented</span><span class="macro">!</span>(),
}</pre>
</div></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>