|
|
<!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 `forward_to_deserialize_any` macro in crate `serde`."><meta name="keywords" content="rust, rustlang, rust-lang, forward_to_deserialize_any"><title>serde::forward_to_deserialize_any - 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="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc macro"><!--[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><a href='../serde/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>serde</a></p><script>window.sidebarCurrent = {name: 'forward_to_deserialize_any', ty: 'macro', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/macros.rs.html#112-120' title='goto source code'>[src]</a></span><span class='in-band'>Macro <a href='index.html'>serde</a>::<wbr><a class="macro" href=''>forward_to_deserialize_any</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><div class="example-wrap"><pre class="rust macro">
|
|
|
<span class="macro">macro_rules</span><span class="macro">!</span> <span class="ident">forward_to_deserialize_any</span> {
|
|
|
(<span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">visitor</span>:<span class="ident">ident</span>: <span class="ident">Visitor</span><span class="op"><</span><span class="macro-nonterminal">$</span><span class="macro-nonterminal">lifetime</span>:<span class="ident">tt</span><span class="op">></span><span class="op">></span> $(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">func</span>:<span class="ident">ident</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
|
|
($(<span class="macro-nonterminal">$</span><span class="macro-nonterminal">func</span>:<span class="ident">ident</span>)<span class="kw-2">*</span>) <span class="op">=</span><span class="op">></span> { ... };
|
|
|
}</pre></div>
|
|
|
</div><div class='docblock'><p>Helper macro when implementing the <code>Deserializer</code> part of a new data format
|
|
|
for Serde.</p>
|
|
|
<p>Some <a href="trait.Deserializer.html"><code>Deserializer</code></a> implementations for self-describing formats do not
|
|
|
care what hint the <a href="de/trait.Visitor.html"><code>Visitor</code></a> gives them, they just want to blindly call
|
|
|
the <a href="de/trait.Visitor.html"><code>Visitor</code></a> method corresponding to the data they can tell is in the
|
|
|
input. This requires repetitive implementations of all the <a href="trait.Deserializer.html"><code>Deserializer</code></a>
|
|
|
trait methods.</p>
|
|
|
<pre><code class="language-edition2018"># use serde::forward_to_deserialize_any;
|
|
|
# use serde::de::{value, Deserializer, Visitor};
|
|
|
#
|
|
|
# struct MyDeserializer;
|
|
|
#
|
|
|
# impl<'de> Deserializer<'de> for MyDeserializer {
|
|
|
# type Error = value::Error;
|
|
|
#
|
|
|
# fn deserialize_any<V>(self, _: V) -> Result<V::Value, Self::Error>
|
|
|
# where
|
|
|
# V: Visitor<'de>,
|
|
|
# {
|
|
|
# unimplemented!()
|
|
|
# }
|
|
|
#
|
|
|
#[inline]
|
|
|
fn deserialize_bool<V>(self, visitor: V) -> Result<V::Value, Self::Error>
|
|
|
where
|
|
|
V: Visitor<'de>,
|
|
|
{
|
|
|
self.deserialize_any(visitor)
|
|
|
}
|
|
|
#
|
|
|
# forward_to_deserialize_any! {
|
|
|
# i8 i16 i32 i64 i128 u8 u16 u32 u64 u128 f32 f64 char str string
|
|
|
# bytes byte_buf option unit unit_struct newtype_struct seq tuple
|
|
|
# tuple_struct map struct enum identifier ignored_any
|
|
|
# }
|
|
|
# }
|
|
|
</code></pre>
|
|
|
<p>The <code>forward_to_deserialize_any!</code> macro implements these simple forwarding
|
|
|
methods so that they forward directly to <a href="trait.Deserializer.html#tymethod.deserialize_any"><code>Deserializer::deserialize_any</code></a>.
|
|
|
You can choose which methods to forward.</p>
|
|
|
<pre><code class="language-edition2018"># use serde::forward_to_deserialize_any;
|
|
|
# use serde::de::{value, Deserializer, Visitor};
|
|
|
#
|
|
|
# struct MyDeserializer;
|
|
|
#
|
|
|
impl<'de> Deserializer<'de> for MyDeserializer {
|
|
|
# type Error = value::Error;
|
|
|
#
|
|
|
fn deserialize_any<V>(self, visitor: V) -> Result<V::Value, Self::Error>
|
|
|
where
|
|
|
V: Visitor<'de>,
|
|
|
{
|
|
|
/* ... */
|
|
|
# let _ = visitor;
|
|
|
# unimplemented!()
|
|
|
}
|
|
|
|
|
|
forward_to_deserialize_any! {
|
|
|
bool i8 i16 i32 i64 i128 u8 u16 u32 u64 u128 f32 f64 char str string
|
|
|
bytes byte_buf option unit unit_struct newtype_struct seq tuple
|
|
|
tuple_struct map struct enum identifier ignored_any
|
|
|
}
|
|
|
}
|
|
|
</code></pre>
|
|
|
<p>The macro assumes the convention that your <code>Deserializer</code> lifetime parameter
|
|
|
is called <code>'de</code> and that the <code>Visitor</code> type parameters on each method are
|
|
|
called <code>V</code>. A different type parameter and a different lifetime can be
|
|
|
specified explicitly if necessary.</p>
|
|
|
<pre><code class="language-edition2018"># use std::marker::PhantomData;
|
|
|
#
|
|
|
# use serde::forward_to_deserialize_any;
|
|
|
# use serde::de::{value, Deserializer, Visitor};
|
|
|
#
|
|
|
# struct MyDeserializer<V>(PhantomData<V>);
|
|
|
#
|
|
|
# impl<'q, V> Deserializer<'q> for MyDeserializer<V> {
|
|
|
# type Error = value::Error;
|
|
|
#
|
|
|
# fn deserialize_any<W>(self, visitor: W) -> Result<W::Value, Self::Error>
|
|
|
# where
|
|
|
# W: Visitor<'q>,
|
|
|
# {
|
|
|
# unimplemented!()
|
|
|
# }
|
|
|
#
|
|
|
forward_to_deserialize_any! {
|
|
|
<W: Visitor<'q>>
|
|
|
bool i8 i16 i32 i64 i128 u8 u16 u32 u64 u128 f32 f64 char str string
|
|
|
bytes byte_buf option unit unit_struct newtype_struct seq tuple
|
|
|
tuple_struct map struct enum identifier ignored_any
|
|
|
}
|
|
|
# }
|
|
|
</code></pre>
|
|
|
</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>⏎</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "serde";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
