47 lines
6.5 KiB
HTML
47 lines
6.5 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="Helper macro when implementing the `Deserializer` part of a new data format for Serde."><title>forward_to_deserialize_any in serde - 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" 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 macro"><!--[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="#">forward_to_deserialize_any</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../serde/index.html">serde</a><span class="version">1.0.228</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"></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</a></div><h1>Macro <span class="macro">forward_<wbr>to_<wbr>deserialize_<wbr>any</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/macros.rs.html#110">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! forward_to_deserialize_any {
|
|
(<$visitor:ident: Visitor<$lifetime:tt>> $($func:ident)*) => { ... };
|
|
($($func:ident)*) => { ... };
|
|
}</code></pre><details class="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" title="trait serde::Deserializer"><code>Deserializer</code></a> implementations for self-describing formats do not
|
|
care what hint the <a href="de/trait.Visitor.html" title="trait serde::de::Visitor"><code>Visitor</code></a> gives them, they just want to blindly call
|
|
the <a href="de/trait.Visitor.html" title="trait serde::de::Visitor"><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" title="trait serde::Deserializer"><code>Deserializer</code></a>
|
|
trait methods.</p>
|
|
|
|
<div class="example-wrap edition"><a href="#" class="tooltip" title="This example runs with edition 2021">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="attr">#[inline]
|
|
</span><span class="kw">fn </span>deserialize_bool<V>(<span class="self">self</span>, visitor: V) -> <span class="prelude-ty">Result</span><V::Value, <span class="self">Self</span>::Error>
|
|
<span class="kw">where
|
|
</span>V: Visitor<<span class="lifetime">'de</span>>,
|
|
{
|
|
<span class="self">self</span>.deserialize_any(visitor)
|
|
}</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" title="method serde::Deserializer::deserialize_any"><code>Deserializer::deserialize_any</code></a>.
|
|
You can choose which methods to forward.</p>
|
|
|
|
<div class="example-wrap edition"><a href="#" class="tooltip" title="This example runs with edition 2021">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">impl</span><<span class="lifetime">'de</span>> Deserializer<<span class="lifetime">'de</span>> <span class="kw">for </span>MyDeserializer {
|
|
<span class="kw">fn </span>deserialize_any<V>(<span class="self">self</span>, visitor: V) -> <span class="prelude-ty">Result</span><V::Value, <span class="self">Self</span>::Error>
|
|
<span class="kw">where
|
|
</span>V: Visitor<<span class="lifetime">'de</span>>,
|
|
{
|
|
<span class="comment">/* ... */
|
|
</span>}
|
|
|
|
<span class="macro">forward_to_deserialize_any!</span> {
|
|
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 <span class="kw">struct enum </span>identifier ignored_any
|
|
}
|
|
}</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="example-wrap edition"><a href="#" class="tooltip" title="This example runs with edition 2021">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="macro">forward_to_deserialize_any!</span> {
|
|
<W: Visitor<<span class="lifetime">'q</span>>>
|
|
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 <span class="kw">struct enum </span>identifier ignored_any
|
|
}</code></pre></div></div></details></section></div></main></body></html> |