18 lines
11 KiB
HTML
18 lines
11 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 trait describing values which may be returned by macro implementation methods used by this crate’s macros."><title>MacroResult in synstructure - 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="synstructure" 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="#">MacroResult</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../synstructure/index.html">synstructure</a><span class="version">0.13.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Macro<wbr>Result</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.into_result" title="into_result">into_result</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.into_stream" title="into_stream">into_stream</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-MacroResult-for-Result%3CT,+Error%3E" title="Result<T>">Result<T></a></li><li><a href="#impl-MacroResult-for-TokenStream" title="TokenStream">TokenStream</a></li><li><a href="#impl-MacroResult-for-TokenStream" title="TokenStream">TokenStream</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate synstructure</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">synstructure</a></div><h1>Trait <span class="trait">Macro<wbr>Result</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/synstructure/lib.rs.html#2466-2491">Source</a> </span></div><pre class="rust item-decl"><code>pub trait MacroResult {
|
||
// Required method
|
||
fn <a href="#tymethod.into_result" class="fn">into_result</a>(self) -> <a class="type" href="../syn/error/type.Result.html" title="type syn::error::Result">Result</a><<a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>>;
|
||
|
||
// Provided method
|
||
fn <a href="#method.into_stream" class="fn">into_stream</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a>
|
||
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper trait describing values which may be returned by macro implementation
|
||
methods used by this crate’s macros.</p>
|
||
</div></details><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.into_result" class="method"><a class="src rightside" href="../src/synstructure/lib.rs.html#2468">Source</a><h4 class="code-header">fn <a href="#tymethod.into_result" class="fn">into_result</a>(self) -> <a class="type" href="../syn/error/type.Result.html" title="type syn::error::Result">Result</a><<a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>></h4></section></summary><div class="docblock"><p>Convert this result into a <code>Result</code> for further processing / validation.</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.into_stream" class="method"><a class="src rightside" href="../src/synstructure/lib.rs.html#2482-2490">Source</a><h4 class="code-header">fn <a href="#method.into_stream" class="fn">into_stream</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a><div class="where">where
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Convert this result into a <code>proc_macro::TokenStream</code>, ready to return
|
||
from a native <code>proc_macro</code> implementation.</p>
|
||
<p>If <code>into_result()</code> would return an <code>Err</code>, this method should instead
|
||
generate a <code>compile_error!</code> invocation to nicely report the error.</p>
|
||
<p><em>This method is available if <code>synstructure</code> is built with the
|
||
<code>"proc-macro"</code> feature.</em></p>
|
||
</div></details></div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-MacroResult-for-TokenStream" class="impl"><a class="src rightside" href="../src/synstructure/lib.rs.html#2507-2511">Source</a><a href="#impl-MacroResult-for-TokenStream" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.MacroResult.html" title="trait synstructure::MacroResult">MacroResult</a> for <a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a></h3></section></summary><div class="impl-items"><section id="method.into_result" class="method trait-impl"><a class="src rightside" href="../src/synstructure/lib.rs.html#2508-2510">Source</a><a href="#method.into_result" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_result" class="fn">into_result</a>(self) -> <a class="type" href="../syn/error/type.Result.html" title="type syn::error::Result">Result</a><<a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-MacroResult-for-TokenStream-1" class="impl"><a class="src rightside" href="../src/synstructure/lib.rs.html#2497-2505">Source</a><a href="#impl-MacroResult-for-TokenStream-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.MacroResult.html" title="trait synstructure::MacroResult">MacroResult</a> for <a class="struct" href="https://doc.rust-lang.org/1.93.1/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a></h3><span class="item-info"><div class="stab portability">Available on <strong>not (WebAssembly and (<code>target_os=unknown</code> or WASI)) and crate feature <code>proc-macro</code></strong> only.</div></span></section></summary><div class="impl-items"><section id="method.into_result-1" class="method trait-impl"><a class="src rightside" href="../src/synstructure/lib.rs.html#2498-2500">Source</a><a href="#method.into_result-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_result" class="fn">into_result</a>(self) -> <a class="type" href="../syn/error/type.Result.html" title="type syn::error::Result">Result</a><<a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>></h4></section><section id="method.into_stream-1" class="method trait-impl"><a class="src rightside" href="../src/synstructure/lib.rs.html#2502-2504">Source</a><a href="#method.into_stream-1" class="anchor">§</a><h4 class="code-header">fn <a href="#method.into_stream" class="fn">into_stream</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/1.93.1/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-MacroResult-for-Result%3CT,+Error%3E" class="impl"><a class="src rightside" href="../src/synstructure/lib.rs.html#2513-2520">Source</a><a href="#impl-MacroResult-for-Result%3CT,+Error%3E" class="anchor">§</a><h3 class="code-header">impl<T: <a class="trait" href="trait.MacroResult.html" title="trait synstructure::MacroResult">MacroResult</a>> <a class="trait" href="trait.MacroResult.html" title="trait synstructure::MacroResult">MacroResult</a> for <a class="type" href="../syn/error/type.Result.html" title="type syn::error::Result">Result</a><T></h3></section></summary><div class="impl-items"><section id="method.into_result-2" class="method trait-impl"><a class="src rightside" href="../src/synstructure/lib.rs.html#2514-2519">Source</a><a href="#method.into_result-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_result" class="fn">into_result</a>(self) -> <a class="type" href="../syn/error/type.Result.html" title="type syn::error::Result">Result</a><<a class="struct" href="../proc_macro2/struct.TokenStream.html" title="struct proc_macro2::TokenStream">TokenStream</a>></h4></section></div></details><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/synstructure/trait.MacroResult.js" data-ignore-extern-crates="proc_macro,proc_macro2,syn" async></script></section></div></main></body></html> |