| <!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="Helper macro when implementing the `Deserializer` part of a new data format for Serde."><meta name="keywords" content="rust, rustlang, rust-lang, forward_to_deserialize_any"><title>forward_to_deserialize_any in serde - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script> |
| <noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../serde/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div> |
| </a><div class="sidebar-elems"><h2 class="location">Other items in<br><a href="index.html">serde</a></h2><div id="sidebar-vars" data-name="forward_to_deserialize_any" data-ty="macro" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../serde/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div> |
| <input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"> |
| <h1 class="fqn"><span class="in-band">Macro <a href="index.html">serde</a>::<wbr><a class="macro" href="#">forward_to_deserialize_any</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"> |
| <a class="srclink" href="../src/serde/macros.rs.html#112-120" title="goto source code">source</a> · |
| <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div> |
| <div class="docblock item-decl"><div class="example-wrap"><pre class="rust macro"><code><span class="macro">macro_rules!</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="macro-nonterminal">$</span><span class="macro-nonterminal">func</span> : <span class="ident">ident</span>) <span class="kw-2">*</span>) => { ... }; |
| }</code></pre></div> |
| </div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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> |
| |
| <div class='information'><div class='tooltip edition' data-edition="2018">ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered edition"><code><span class="attribute">#[<span class="ident">inline</span>]</span> |
| <span class="kw">fn</span> <span class="ident">deserialize_bool</span><span class="op"><</span><span class="ident">V</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">visitor</span>: <span class="ident">V</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">V::Value</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> |
| <span class="kw">where</span> |
| <span class="ident">V</span>: <span class="ident">Visitor</span><span class="op"><</span><span class="lifetime">'de</span><span class="op">></span>, |
| { |
| <span class="self">self</span>.<span class="ident">deserialize_any</span>(<span class="ident">visitor</span>) |
| }</code></pre></div> |
| <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> |
| |
| <div class='information'><div class='tooltip edition' data-edition="2018">ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered edition"><code><span class="kw">impl</span><span class="op"><</span><span class="lifetime">'de</span><span class="op">></span> <span class="ident">Deserializer</span><span class="op"><</span><span class="lifetime">'de</span><span class="op">></span> <span class="kw">for</span> <span class="ident">MyDeserializer</span> { |
| <span class="kw">fn</span> <span class="ident">deserialize_any</span><span class="op"><</span><span class="ident">V</span><span class="op">></span>(<span class="self">self</span>, <span class="ident">visitor</span>: <span class="ident">V</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">V::Value</span>, <span class="ident"><span class="self">Self</span>::Error</span><span class="op">></span> |
| <span class="kw">where</span> |
| <span class="ident">V</span>: <span class="ident">Visitor</span><span class="op"><</span><span class="lifetime">'de</span><span class="op">></span>, |
| { |
| <span class="comment">/* ... */</span> |
| } |
| |
| <span class="macro">forward_to_deserialize_any!</span> { |
| <span class="ident">bool</span> <span class="ident">i8</span> <span class="ident">i16</span> <span class="ident">i32</span> <span class="ident">i64</span> <span class="ident">i128</span> <span class="ident">u8</span> <span class="ident">u16</span> <span class="ident">u32</span> <span class="ident">u64</span> <span class="ident">u128</span> <span class="ident">f32</span> <span class="ident">f64</span> <span class="ident">char</span> <span class="ident">str</span> <span class="ident">string</span> |
| <span class="ident">bytes</span> <span class="ident">byte_buf</span> <span class="ident">option</span> <span class="ident">unit</span> <span class="ident">unit_struct</span> <span class="ident">newtype_struct</span> <span class="ident">seq</span> <span class="ident">tuple</span> |
| <span class="ident">tuple_struct</span> <span class="ident">map</span> <span class="kw">struct</span> <span class="kw">enum</span> <span class="ident">identifier</span> <span class="ident">ignored_any</span> |
| } |
| }</code></pre></div> |
| <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> |
| |
| <div class='information'><div class='tooltip edition' data-edition="2018">ⓘ</div></div><div class="example-wrap"><pre class="rust rust-example-rendered edition"><code><span class="macro">forward_to_deserialize_any!</span> { |
| <span class="op"><</span><span class="ident">W</span>: <span class="ident">Visitor</span><span class="op"><</span><span class="lifetime">'q</span><span class="op">></span><span class="op">></span> |
| <span class="ident">bool</span> <span class="ident">i8</span> <span class="ident">i16</span> <span class="ident">i32</span> <span class="ident">i64</span> <span class="ident">i128</span> <span class="ident">u8</span> <span class="ident">u16</span> <span class="ident">u32</span> <span class="ident">u64</span> <span class="ident">u128</span> <span class="ident">f32</span> <span class="ident">f64</span> <span class="ident">char</span> <span class="ident">str</span> <span class="ident">string</span> |
| <span class="ident">bytes</span> <span class="ident">byte_buf</span> <span class="ident">option</span> <span class="ident">unit</span> <span class="ident">unit_struct</span> <span class="ident">newtype_struct</span> <span class="ident">seq</span> <span class="ident">tuple</span> |
| <span class="ident">tuple_struct</span> <span class="ident">map</span> <span class="kw">struct</span> <span class="kw">enum</span> <span class="ident">identifier</span> <span class="ident">ignored_any</span> |
| }</code></pre></div> |
| </div></details></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="serde" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (1bd4fdc94 2022-01-12)" ></div> |
| </body></html> |
