181 lines
17 KiB
HTML
181 lines
17 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 `EnumAccess` trait in crate `serde`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, EnumAccess">
|
|||
|
|
|
|||
|
|
<title>serde::de::EnumAccess - 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 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">
|
|||
|
|
<div class="sidebar-menu">☰</div>
|
|||
|
|
|
|||
|
|
<p class='location'>Trait EnumAccess</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Error">Error</a><a href="#associatedtype.Variant">Variant</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.variant_seed">variant_seed</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.variant">variant</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>serde</a>::<wbr><a href='index.html'>de</a></p><script>window.sidebarCurrent = {name: 'EnumAccess', ty: 'trait', 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'>Trait <a href='../index.html'>serde</a>::<wbr><a href='index.html'>de</a>::<wbr><a class="trait" href=''>EnumAccess</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#1950-1977' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust trait'>pub trait EnumAccess<'de>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|||
|
|
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>;
|
|||
|
|
type <a href='#associatedtype.Variant' class="type">Variant</a>: <a class="trait" href="../../serde/de/trait.VariantAccess.html" title="trait serde::de::VariantAccess">VariantAccess</a><'de, Error = Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::Error">Error</a>>;
|
|||
|
|
fn <a href='#tymethod.variant_seed' class='fnname'>variant_seed</a><V>(<br> self, <br> seed: 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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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.EnumAccess.html#associatedtype.Variant" title="type serde::de::EnumAccess::Variant">Variant</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::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.variant' class='fnname'>variant</a><V>(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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>V, Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Variant" title="type serde::de::EnumAccess::Variant">Variant</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::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>,
|
|||
|
|
{ ... }
|
|||
|
|
}</pre><div class='docblock'><p>Provides a <code>Visitor</code> access to the data of an enum in the input.</p>
|
|||
|
|
<p><code>EnumAccess</code> is created by the <code>Deserializer</code> and passed to the
|
|||
|
|
<code>Visitor</code> in order to identify which variant of an enum to deserialize.</p>
|
|||
|
|
<h1 id="lifetime" class="section-header"><a href="#lifetime">Lifetime</a></h1>
|
|||
|
|
<p>The <code>'de</code> lifetime of this trait is the lifetime of data that may be
|
|||
|
|
borrowed by the deserialized enum variant. See the page <a href="https://serde.rs/lifetimes.html">Understanding
|
|||
|
|
deserializer lifetimes</a> for a more detailed explanation of these lifetimes.</p>
|
|||
|
|
<h1 id="example-implementation" class="section-header"><a href="#example-implementation">Example implementation</a></h1>
|
|||
|
|
<p>The <a href="https://serde.rs/data-format.html">example data format</a> presented on the website demonstrates an
|
|||
|
|
implementation of <code>EnumAccess</code> for a basic JSON data format.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='associated-types' class='small-section-header'>
|
|||
|
|
Associated Types<a href='#associated-types' class='anchor'></a>
|
|||
|
|
</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><h3 id='associatedtype.Variant' class='method'><span id='Variant.t' class='invisible'><code>type <a href='#associatedtype.Variant' class="type">Variant</a>: <a class="trait" href="../../serde/de/trait.VariantAccess.html" title="trait serde::de::VariantAccess">VariantAccess</a><'de, Error = Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::Error">Error</a>></code></span></h3><div class='docblock'><p>The <code>Visitor</code> that will be used to deserialize the content of the enum
|
|||
|
|
variant.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='required-methods' class='small-section-header'>
|
|||
|
|
Required Methods<a href='#required-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='tymethod.variant_seed' class='method'><span id='variant_seed.v' class='invisible'><code>fn <a href='#tymethod.variant_seed' class='fnname'>variant_seed</a><V>(<br> self, <br> seed: 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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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.EnumAccess.html#associatedtype.Variant" title="type serde::de::EnumAccess::Variant">Variant</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::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><code>variant</code> is called to identify which variant to deserialize.</p>
|
|||
|
|
<p><code>Deserialize</code> implementations should typically use <code>EnumAccess::variant</code>
|
|||
|
|
instead.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='provided-methods' class='small-section-header'>
|
|||
|
|
Provided Methods<a href='#provided-methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<div class='methods'>
|
|||
|
|
<h3 id='method.variant' class='method'><span id='variant.v' class='invisible'><code>fn <a href='#method.variant' class='fnname'>variant</a><V>(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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>V, Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Variant" title="type serde::de::EnumAccess::Variant">Variant</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, Self::<a class="type" href="../../serde/de/trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::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><code>variant</code> is called to identify which variant to deserialize.</p>
|
|||
|
|
<p>This method exists as a convenience for <code>Deserialize</code> implementations.
|
|||
|
|
<code>EnumAccess</code> implementations should not override the default behavior.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementors' class='small-section-header'>
|
|||
|
|
Implementors<a href='#implementors' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<ul class='item-list' id='implementors-list'>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/serde/de/value.rs.html#345-358' title='goto source code'>[src]</a></div><code>impl<'de, E> EnumAccess<'de> for <a class="struct" href="../../serde/de/value/struct.U32Deserializer.html" title="struct serde::de::value::U32Deserializer">U32Deserializer</a><E> <span class="where fmt-newline">where<br> E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = E;</span><span class="where fmt-newline"> type <a href='#associatedtype.Variant' class="type">Variant</a> = UnitOnly<E>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/serde/de/value.rs.html#419-432' title='goto source code'>[src]</a></div><code>impl<'de, 'a, E> EnumAccess<'de> for <a class="struct" href="../../serde/de/value/struct.StrDeserializer.html" title="struct serde::de::value::StrDeserializer">StrDeserializer</a><'a, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = E;</span><span class="where fmt-newline"> type <a href='#associatedtype.Variant' class="type">Variant</a> = UnitOnly<E>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/serde/de/value.rs.html#490-503' title='goto source code'>[src]</a></div><code>impl<'de, E> EnumAccess<'de> for <a class="struct" href="../../serde/de/value/struct.BorrowedStrDeserializer.html" title="struct serde::de::value::BorrowedStrDeserializer">BorrowedStrDeserializer</a><'de, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = E;</span><span class="where fmt-newline"> type <a href='#associatedtype.Variant' class="type">Variant</a> = UnitOnly<E>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/serde/de/value.rs.html#576-589' title='goto source code'>[src]</a></div><code>impl<'de, 'a, E> EnumAccess<'de> for <a class="struct" href="../../serde/de/value/struct.StringDeserializer.html" title="struct serde::de::value::StringDeserializer">StringDeserializer</a><E> <span class="where fmt-newline">where<br> E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = E;</span><span class="where fmt-newline"> type <a href='#associatedtype.Variant' class="type">Variant</a> = UnitOnly<E>;</span></code></li>
|
|||
|
|
<li><div class='out-of-band'><a class='srclink' href='../../src/serde/de/value.rs.html#665-678' title='goto source code'>[src]</a></div><code>impl<'de, 'a, E> EnumAccess<'de> for <a class="struct" href="../../serde/de/value/struct.CowStrDeserializer.html" title="struct serde::de::value::CowStrDeserializer">CowStrDeserializer</a><'a, E> <span class="where fmt-newline">where<br> E: <a class="trait" href="../../serde/de/trait.Error.html" title="trait serde::de::Error">Error</a>, </span><span class="where fmt-newline"> type <a href='#associatedtype.Error' class="type">Error</a> = E;</span><span class="where fmt-newline"> type <a href='#associatedtype.Variant' class="type">Variant</a> = UnitOnly<E>;</span></code></li>
|
|||
|
|
</ul><script type="text/javascript" async
|
|||
|
|
src="../../implementors/serde/de/trait.EnumAccess.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><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>⏎</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";
|
|||
|
|
</script>
|
|||
|
|
<script src="../../main.js"></script>
|
|||
|
|
<script defer src="../../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|