mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 16:38:24 +00:00
47 lines
20 KiB
HTML
47 lines
20 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::de - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-5bc39a1768837dd0.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="serde" data-themes="" data-resource-suffix="" data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)" data-channel="1.77.0" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../serde/index.html">serde</a><span class="version">1.0.197</span></h2></div><h2 class="location"><a href="#">EnumAccess</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error">Error</a></li><li><a href="#associatedtype.Variant">Variant</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.variant_seed">variant_seed</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.variant">variant</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In serde::de</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../serde/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../index.html">serde</a>::<wbr><a href="index.html">de</a>::<wbr><a class="trait" href="#">EnumAccess</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/serde/de/mod.rs.html#1978-2005">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait EnumAccess<'de>: <a class="trait" href="https://doc.rust-lang.org/1.77.0/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::de::Error">Error</a>;
|
||
type <a href="#associatedtype.Variant" class="associatedtype">Variant</a>: <a class="trait" href="trait.VariantAccess.html" title="trait serde::de::VariantAccess">VariantAccess</a><'de, Error = Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde::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.77.0/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::de::DeserializeSeed::Value">Value</a>, Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Variant" title="type serde::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::Error">Error</a>>
|
||
<span class="where">where V: <a class="trait" href="trait.DeserializeSeed.html" title="trait serde::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.77.0/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::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::Error">Error</a>>
|
||
<span class="where">where V: <a class="trait" href="../trait.Deserialize.html" title="trait serde::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/de/mod.rs.html#1981">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::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/de/mod.rs.html#1984">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::de::VariantAccess">VariantAccess</a><'de, Error = Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde::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/de/mod.rs.html#1990-1992">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.77.0/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::de::DeserializeSeed::Value">Value</a>, Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Variant" title="type serde::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::Error">Error</a>><div class="where">where
|
||
V: <a class="trait" href="trait.DeserializeSeed.html" title="trait serde::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/de/mod.rs.html#1999-2004">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.77.0/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::de::EnumAccess::Variant">Variant</a>), Self::<a class="associatedtype" href="trait.EnumAccess.html#associatedtype.Error" title="type serde::de::EnumAccess::Error">Error</a>><div class="where">where
|
||
V: <a class="trait" href="../trait.Deserialize.html" title="trait serde::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="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.77.0/reference/items/traits.html#object-safety">object safe</a>.</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/de/value.rs.html#752-765">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::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.CowStrDeserializer.html" title="struct serde::de::value::CowStrDeserializer">CowStrDeserializer</a><'a, E><div class="where">where
|
||
E: <a class="trait" href="trait.Error.html" title="trait serde::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><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 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/de/value.rs.html#461-474">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::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.StrDeserializer.html" title="struct serde::de::value::StrDeserializer">StrDeserializer</a><'a, E><div class="where">where
|
||
E: <a class="trait" href="trait.Error.html" title="trait serde::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-2" class="associatedtype trait-impl"><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 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/de/value.rs.html#1501-1517">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::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.MapAccessDeserializer.html" title="struct serde::de::value::MapAccessDeserializer">MapAccessDeserializer</a><A><div class="where">where
|
||
A: <a class="trait" href="trait.MapAccess.html" title="trait serde::de::MapAccess">MapAccess</a><'de>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-3" class="associatedtype trait-impl"><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::de::MapAccess">MapAccess</a><'de>>::<a class="associatedtype" href="trait.MapAccess.html#associatedtype.Error" title="type serde::de::MapAccess::Error">Error</a></h4></section><section id="associatedtype.Variant-3" class="associatedtype trait-impl"><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/de/value.rs.html#540-553">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::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.BorrowedStrDeserializer.html" title="struct serde::de::value::BorrowedStrDeserializer">BorrowedStrDeserializer</a><'de, E><div class="where">where
|
||
E: <a class="trait" href="trait.Error.html" title="trait serde::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-4" class="associatedtype trait-impl"><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 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/de/value.rs.html#644-657">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::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.StringDeserializer.html" title="struct serde::de::value::StringDeserializer">StringDeserializer</a><E><div class="where">where
|
||
E: <a class="trait" href="trait.Error.html" title="trait serde::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-5" class="associatedtype trait-impl"><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 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/de/value.rs.html#372-385">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::de::EnumAccess">EnumAccess</a><'de> for <a class="struct" href="value/struct.U32Deserializer.html" title="struct serde::de::value::U32Deserializer">U32Deserializer</a><E><div class="where">where
|
||
E: <a class="trait" href="trait.Error.html" title="trait serde::de::Error">Error</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-6" class="associatedtype trait-impl"><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 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/de/trait.EnumAccess.js" async></script></section></div></main></body></html> |