46 lines
21 KiB
HTML
46 lines
21 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="Provides a `Visitor` access to the data of an enum in the input."><title>EnumAccess in serde_core::de - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="serde_core" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">EnumAccess</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde_core/index.html">serde_<wbr>core</a><span class="version">1.0.228</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Enum<wbr>Access</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#lifetime" title="Lifetime">Lifetime</a></li><li><a href="#example-implementation" title="Example implementation">Example implementation</a></li></ul><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li><li><a href="#associatedtype.Variant" title="Variant">Variant</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.variant_seed" title="variant_seed">variant_seed</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.variant" title="variant">variant</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In serde_<wbr>core::<wbr>de</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">serde_core</a>::<wbr><a href="index.html">de</a></div><h1>Trait <span class="trait">Enum<wbr>Access</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/serde_core/de/mod.rs.html#2035-2062">Source</a> </span></div><pre class="rust item-decl"><code>pub trait EnumAccess<'de>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="trait.Error.html" title="trait serde_core::de::Error">Error</a>;
|
|
type <a href="#associatedtype.Variant" class="associatedtype">Variant</a>: <a class="trait" href="trait.VariantAccess.html" title="trait serde_core::de::VariantAccess">VariantAccess</a><'de, Error = Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde_core::de::EnumAccess::Error">Error</a>>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.variant_seed" class="fn">variant_seed</a><V>(
|
|
self,
|
|
seed: V,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(V::<a class="associatedtype" href="trait.DeserializeSeed.html#associatedtype.Value" title="type serde_core::de::DeserializeSeed::Value">Value</a>, Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Variant" title="type serde_core::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde_core::de::EnumAccess::Error">Error</a>>
|
|
<span class="where">where V: <a class="trait" href="trait.DeserializeSeed.html" title="trait serde_core::de::DeserializeSeed">DeserializeSeed</a><'de></span>;
|
|
|
|
// Provided method
|
|
fn <a href="#method.variant" class="fn">variant</a><V>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(V, Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Variant" title="type serde_core::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde_core::de::EnumAccess::Error">Error</a>>
|
|
<span class="where">where V: <a class="trait" href="../trait.Deserialize.html" title="trait serde_core::Deserialize">Deserialize</a><'de></span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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>
|
|
<h2 id="lifetime"><a class="doc-anchor" href="#lifetime">§</a>Lifetime</h2>
|
|
<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>
|
|
<h2 id="example-implementation"><a class="doc-anchor" href="#example-implementation">§</a>Example implementation</h2>
|
|
<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></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/serde_core/de/mod.rs.html#2038">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="trait.Error.html" title="trait serde_core::de::Error">Error</a></h4></section></summary><div class="docblock"><p>The error type that can be returned if some error occurs during
|
|
deserialization.</p>
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.Variant" class="method"><a class="src rightside" href="../../src/serde_core/de/mod.rs.html#2041">Source</a><h4 class="code-header">type <a href="#associatedtype.Variant" class="associatedtype">Variant</a>: <a class="trait" href="trait.VariantAccess.html" title="trait serde_core::de::VariantAccess">VariantAccess</a><'de, Error = Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde_core::de::EnumAccess::Error">Error</a>></h4></section></summary><div class="docblock"><p>The <code>Visitor</code> that will be used to deserialize the content of the enum
|
|
variant.</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.variant_seed" class="method"><a class="src rightside" href="../../src/serde_core/de/mod.rs.html#2047-2049">Source</a><h4 class="code-header">fn <a href="#tymethod.variant_seed" class="fn">variant_seed</a><V>(
|
|
self,
|
|
seed: V,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(V::<a class="associatedtype" href="trait.DeserializeSeed.html#associatedtype.Value" title="type serde_core::de::DeserializeSeed::Value">Value</a>, Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Variant" title="type serde_core::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde_core::de::EnumAccess::Error">Error</a>><div class="where">where
|
|
V: <a class="trait" href="trait.DeserializeSeed.html" title="trait serde_core::de::DeserializeSeed">DeserializeSeed</a><'de>,</div></h4></section></summary><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></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.variant" class="method"><a class="src rightside" href="../../src/serde_core/de/mod.rs.html#2056-2061">Source</a><h4 class="code-header">fn <a href="#method.variant" class="fn">variant</a><V>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><(V, Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Variant" title="type serde_core::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde_core::de::EnumAccess::Error">Error</a>><div class="where">where
|
|
V: <a class="trait" href="../trait.Deserialize.html" title="trait serde_core::Deserialize">Deserialize</a><'de>,</div></h4></section></summary><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></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-EnumAccess%3C'de%3E-for-CowStrDeserializer%3C'a,+E%3E" class="impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#844-857">Source</a><a href="#impl-EnumAccess%3C'de%3E-for-CowStrDeserializer%3C'a,+E%3E" class="anchor">§</a><h3 class="code-header">impl<'de, 'a, E> <a class="trait" href="trait.EnumAccess.html" title="trait serde_core::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.CowStrDeserializer.html" title="struct serde_core::de::value::CowStrDeserializer">CowStrDeserializer</a><'a, E><div class="where">where
|
|
E: <a class="trait" href="trait.Error.html" title="trait serde_core::de::Error">Error</a>,</div></h3><span class="item-info"><div class="stab portability">Available on <strong>crate features <code>std</code> or <code>alloc</code></strong> only.</div></span></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#848">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section><section id="associatedtype.Variant-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#849">Source</a><a href="#associatedtype.Variant-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Variant" class="associatedtype">Variant</a> = UnitOnly<E></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-EnumAccess%3C'de%3E-for-StrDeserializer%3C'a,+E%3E" class="impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#518-531">Source</a><a href="#impl-EnumAccess%3C'de%3E-for-StrDeserializer%3C'a,+E%3E" class="anchor">§</a><h3 class="code-header">impl<'de, 'a, E> <a class="trait" href="trait.EnumAccess.html" title="trait serde_core::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.StrDeserializer.html" title="struct serde_core::de::value::StrDeserializer">StrDeserializer</a><'a, E><div class="where">where
|
|
E: <a class="trait" href="trait.Error.html" title="trait serde_core::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#522">Source</a><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section><section id="associatedtype.Variant-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#523">Source</a><a href="#associatedtype.Variant-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Variant" class="associatedtype">Variant</a> = UnitOnly<E></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-EnumAccess%3C'de%3E-for-MapAccessDeserializer%3CA%3E" class="impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#1665-1681">Source</a><a href="#impl-EnumAccess%3C'de%3E-for-MapAccessDeserializer%3CA%3E" class="anchor">§</a><h3 class="code-header">impl<'de, A> <a class="trait" href="trait.EnumAccess.html" title="trait serde_core::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.MapAccessDeserializer.html" title="struct serde_core::de::value::MapAccessDeserializer">MapAccessDeserializer</a><A><div class="where">where
|
|
A: <a class="trait" href="trait.MapAccess.html" title="trait serde_core::de::MapAccess">MapAccess</a><'de>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#1669">Source</a><a href="#associatedtype.Error-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <A as <a class="trait" href="trait.MapAccess.html" title="trait serde_core::de::MapAccess">MapAccess</a><'de>>::<a class="associatedtype" href="trait.MapAccess.html#associatedtype.Error" title="type serde_core::de::MapAccess::Error">Error</a></h4></section><section id="associatedtype.Variant-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#1670">Source</a><a href="#associatedtype.Variant-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Variant" class="associatedtype">Variant</a> = MapAsEnum<A></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-EnumAccess%3C'de%3E-for-BorrowedStrDeserializer%3C'de,+E%3E" class="impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#608-621">Source</a><a href="#impl-EnumAccess%3C'de%3E-for-BorrowedStrDeserializer%3C'de,+E%3E" class="anchor">§</a><h3 class="code-header">impl<'de, E> <a class="trait" href="trait.EnumAccess.html" title="trait serde_core::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.BorrowedStrDeserializer.html" title="struct serde_core::de::value::BorrowedStrDeserializer">BorrowedStrDeserializer</a><'de, E><div class="where">where
|
|
E: <a class="trait" href="trait.Error.html" title="trait serde_core::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-4" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#612">Source</a><a href="#associatedtype.Error-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section><section id="associatedtype.Variant-4" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#613">Source</a><a href="#associatedtype.Variant-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Variant" class="associatedtype">Variant</a> = UnitOnly<E></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-EnumAccess%3C'de%3E-for-StringDeserializer%3CE%3E" class="impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#724-737">Source</a><a href="#impl-EnumAccess%3C'de%3E-for-StringDeserializer%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<'de, E> <a class="trait" href="trait.EnumAccess.html" title="trait serde_core::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.StringDeserializer.html" title="struct serde_core::de::value::StringDeserializer">StringDeserializer</a><E><div class="where">where
|
|
E: <a class="trait" href="trait.Error.html" title="trait serde_core::de::Error">Error</a>,</div></h3><span class="item-info"><div class="stab portability">Available on <strong>crate features <code>std</code> or <code>alloc</code></strong> only.</div></span></section></summary><div class="impl-items"><section id="associatedtype.Error-5" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#728">Source</a><a href="#associatedtype.Error-5" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section><section id="associatedtype.Variant-5" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#729">Source</a><a href="#associatedtype.Variant-5" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Variant" class="associatedtype">Variant</a> = UnitOnly<E></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-EnumAccess%3C'de%3E-for-U32Deserializer%3CE%3E" class="impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#418-431">Source</a><a href="#impl-EnumAccess%3C'de%3E-for-U32Deserializer%3CE%3E" class="anchor">§</a><h3 class="code-header">impl<'de, E> <a class="trait" href="trait.EnumAccess.html" title="trait serde_core::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.U32Deserializer.html" title="struct serde_core::de::value::U32Deserializer">U32Deserializer</a><E><div class="where">where
|
|
E: <a class="trait" href="trait.Error.html" title="trait serde_core::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-6" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#422">Source</a><a href="#associatedtype.Error-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section><section id="associatedtype.Variant-6" class="associatedtype trait-impl"><a class="src rightside" href="../../src/serde_core/de/value.rs.html#423">Source</a><a href="#associatedtype.Variant-6" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Variant" class="associatedtype">Variant</a> = UnitOnly<E></h4></section></div></details></div><script src="../../trait.impl/serde_core/de/trait.EnumAccess.js" async></script></section></div></main></body></html> |