187 lines
22 KiB
HTML
187 lines
22 KiB
HTML
<!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 `MapAccess` trait in crate `serde`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, MapAccess">
|
||
|
||
<title>serde::de::MapAccess - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc trait">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'>Trait MapAccess</p><div class="block items"><ul><li><a href="#associated-types">Associated Types</a></li><li><a href="#required-methods">Required Methods</a></li><li><a href="#provided-methods">Provided Methods</a></li><li><a href="#implementors">Implementors</a></li></ul></div><p class='location'><a href='../index.html'>serde</a>::<wbr><a href='index.html'>de</a></p><script>window.sidebarCurrent = {name: 'MapAccess', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<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'>Trait <a href='../index.html'>serde</a>::<wbr><a href='index.html'>de</a>::<wbr><a class="trait" href=''>MapAccess</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/serde/de/mod.rs.html#1485-1588' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust trait'>pub trait MapAccess<'de> {
|
||
type <a href='#associatedtype.Error' class="type">Error</a>: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>;
|
||
fn <a href='#tymethod.next_key_seed' class='fnname'>next_key_seed</a><K>(<br> &mut self, <br> seed: K<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><K::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a>>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>><br> <span class="where">where<br> K: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de></span>;
|
||
fn <a href='#tymethod.next_value_seed' class='fnname'>next_value_seed</a><V>(&mut self, seed: V) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><V::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>><br> <span class="where">where<br> V: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de></span>;
|
||
|
||
fn <a href='#method.next_entry_seed' class='fnname'>next_entry_seed</a><K, V>(<br> &mut self, <br> kseed: K, <br> vseed: V<br> ) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a>, V::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>><br> <span class="where">where<br> K: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de>,<br> V: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de></span>,
|
||
{ ... }
|
||
fn <a href='#method.next_key' class='fnname'>next_key</a><K>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><K>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>><br> <span class="where">where<br> K: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de></span>,
|
||
{ ... }
|
||
fn <a href='#method.next_value' class='fnname'>next_value</a><V>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><V, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>><br> <span class="where">where<br> V: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de></span>,
|
||
{ ... }
|
||
fn <a href='#method.next_entry' class='fnname'>next_entry</a><K, V>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>><br> <span class="where">where<br> K: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de>,<br> V: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de></span>,
|
||
{ ... }
|
||
fn <a href='#method.size_hint' class='fnname'>size_hint</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> { ... }
|
||
}</pre><div class='docblock'><p>Provides a <code>Visitor</code> access to each entry of a map in the input.</p>
|
||
|
||
<p>This is a trait that a <code>Deserializer</code> passes to a <code>Visitor</code> implementation.</p>
|
||
</div>
|
||
<h2 id='associated-types'>Associated Types</h2>
|
||
<div class='methods'>
|
||
<h3 id='associatedtype.Error' class='method'><span id='Error.t' class='invisible'><code>type <a href='#associatedtype.Error' class="type">Error</a>: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a></code></span></h3><div class='docblock'><p>The error type that can be returned if some error occurs during
|
||
deserialization.</p>
|
||
</div></div>
|
||
<h2 id='required-methods'>Required Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.next_key_seed' class='method'><span id='next_key_seed.v' class='invisible'><code>fn <a href='#tymethod.next_key_seed' class='fnname'>next_key_seed</a><K>(&mut self, seed: K) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><K::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a>>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>> <span class="where fmt-newline">where<br> K: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de>, </span></code></span></h3><div class='docblock'><p>This returns <code>Ok(Some(key))</code> for the next key in the map, or <code>Ok(None)</code>
|
||
if there are no more remaining entries.</p>
|
||
|
||
<p><code>Deserialize</code> implementations should typically use
|
||
<code>MapAccess::next_key</code> or <code>MapAccess::next_entry</code> instead.</p>
|
||
</div><h3 id='tymethod.next_value_seed' class='method'><span id='next_value_seed.v' class='invisible'><code>fn <a href='#tymethod.next_value_seed' class='fnname'>next_value_seed</a><V>(&mut self, seed: V) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><V::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>> <span class="where fmt-newline">where<br> V: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de>, </span></code></span></h3><div class='docblock'><p>This returns a <code>Ok(value)</code> for the next value in the map.</p>
|
||
|
||
<p><code>Deserialize</code> implementations should typically use
|
||
<code>MapAccess::next_value</code> instead.</p>
|
||
|
||
<h1 id='panics' class='section-header'><a href='#panics'>Panics</a></h1>
|
||
<p>Calling <code>next_value_seed</code> before <code>next_key_seed</code> is incorrect and is
|
||
allowed to panic or return bogus results.</p>
|
||
</div></div>
|
||
<h2 id='provided-methods'>Provided Methods</h2>
|
||
<div class='methods'>
|
||
<h3 id='method.next_entry_seed' class='method'><span id='next_entry_seed.v' class='invisible'><code>fn <a href='#method.next_entry_seed' class='fnname'>next_entry_seed</a><K, V>(<br> &mut self, <br> kseed: K, <br> vseed: V<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a>, V::<a class="type" href="../../serde/de/trait.DeserializeSeed.html#associatedtype.Value" title="type serde::de::DeserializeSeed::Value">Value</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>> <span class="where fmt-newline">where<br> K: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de>,<br> V: <a class="trait" href="../../serde/de/trait.DeserializeSeed.html" title="trait serde::de::DeserializeSeed">DeserializeSeed</a><'de>, </span></code></span></h3><div class='docblock'><p>This returns <code>Ok(Some((key, value)))</code> for the next (key-value) pair in
|
||
the map, or <code>Ok(None)</code> if there are no more remaining items.</p>
|
||
|
||
<p><code>MapAccess</code> implementations should override the default behavior if a
|
||
more efficient implementation is possible.</p>
|
||
|
||
<p><code>Deserialize</code> implementations should typically use
|
||
<code>MapAccess::next_entry</code> instead.</p>
|
||
</div><h3 id='method.next_key' class='method'><span id='next_key.v' class='invisible'><code>fn <a href='#method.next_key' class='fnname'>next_key</a><K>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><K>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>> <span class="where fmt-newline">where<br> K: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de>, </span></code></span></h3><div class='docblock'><p>This returns <code>Ok(Some(key))</code> for the next key in the map, or <code>Ok(None)</code>
|
||
if there are no more remaining entries.</p>
|
||
|
||
<p>This method exists as a convenience for <code>Deserialize</code> implementations.
|
||
<code>MapAccess</code> implementations should not override the default behavior.</p>
|
||
</div><h3 id='method.next_value' class='method'><span id='next_value.v' class='invisible'><code>fn <a href='#method.next_value' class='fnname'>next_value</a><V>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><V, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>> <span class="where fmt-newline">where<br> V: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de>, </span></code></span></h3><div class='docblock'><p>This returns a <code>Ok(value)</code> for the next value in the map.</p>
|
||
|
||
<p>This method exists as a convenience for <code>Deserialize</code> implementations.
|
||
<code>MapAccess</code> implementations should not override the default behavior.</p>
|
||
|
||
<h1 id='panics-1' class='section-header'><a href='#panics-1'>Panics</a></h1>
|
||
<p>Calling <code>next_value</code> before <code>next_key</code> is incorrect and is allowed to
|
||
panic or return bogus results.</p>
|
||
</div><h3 id='method.next_entry' class='method'><span id='next_entry.v' class='invisible'><code>fn <a href='#method.next_entry' class='fnname'>next_entry</a><K, V>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, V<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>, Self::<a class="type" href="../../serde/de/trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a>> <span class="where fmt-newline">where<br> K: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de>,<br> V: <a class="trait" href="../../serde/trait.Deserialize.html" title="trait serde::Deserialize">Deserialize</a><'de>, </span></code></span></h3><div class='docblock'><p>This returns <code>Ok(Some((key, value)))</code> for the next (key-value) pair in
|
||
the map, or <code>Ok(None)</code> if there are no more remaining items.</p>
|
||
|
||
<p>This method exists as a convenience for <code>Deserialize</code> implementations.
|
||
<code>MapAccess</code> implementations should not override the default behavior.</p>
|
||
</div><h3 id='method.size_hint' class='method'><span id='size_hint.v' class='invisible'><code>fn <a href='#method.size_hint' class='fnname'>size_hint</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></span></h3><div class='docblock'><p>Returns the number of entries remaining in the map, if known.</p>
|
||
</div></div>
|
||
<h2 id='implementors'>Implementors</h2>
|
||
<ul class='item-list' id='implementors-list'>
|
||
<li><code>impl<'de, I, E> MapAccess<'de> for <a class="struct" href="../../serde/de/value/struct.MapDeserializer.html" title="struct serde::de::value::MapDeserializer">MapDeserializer</a><'de, I, E> <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a>,<br> I::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a>: Pair,<br> <I::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a> as Pair>::First: <a class="trait" href="../../serde/de/trait.IntoDeserializer.html" title="trait serde::de::IntoDeserializer">IntoDeserializer</a><'de, E>,<br> <I::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::iterator::Iterator::Item">Item</a> as Pair>::Second: <a class="trait" href="../../serde/de/trait.IntoDeserializer.html" title="trait serde::de::IntoDeserializer">IntoDeserializer</a><'de, E>,<br> E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>, </span></code></li>
|
||
<li><code>impl<'de, 'a, A> MapAccess<'de> for &'a mut A <span class="where fmt-newline">where<br> A: <a class="trait" href="../../serde/de/trait.MapAccess.html" title="trait serde::de::MapAccess">MapAccess</a><'de>, </span></code></li>
|
||
</ul><script type="text/javascript" async
|
||
src="../../implementors/serde/de/trait.MapAccess.js">
|
||
</script></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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand 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";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |