19 lines
11 KiB
HTML
19 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="API documentation for the Rust `MacroResult` trait in crate `synstructure`."><meta name="keywords" content="rust, rustlang, rust-lang, MacroResult"><title>synstructure::MacroResult - 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 trait"><!--[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='../synstructure/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait MacroResult</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.into_result">into_result</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.into_stream">into_stream</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-MacroResult-for-Result%3CT%3E">Result<T></a><a href="#impl-MacroResult-for-TokenStream">TokenStream</a><a href="#impl-MacroResult-for-TokenStream">TokenStream</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>synstructure</a></p><script>window.sidebarCurrent = {name: 'MacroResult', ty: 'trait', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled 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/synstructure/lib.rs.html#2311-2336' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>synstructure</a>::<wbr><a class="trait" href=''>MacroResult</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait MacroResult {
|
||
fn <a href='#tymethod.into_result' class='fnname'>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>>;
|
||
|
||
fn <a href='#method.into_stream' class='fnname'>into_stream</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a><br> <span class="where">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span>,
|
||
{ ... }
|
||
}</pre></div><div class='docblock'><p>Helper trait describing values which may be returned by macro implementation
|
||
methods used by this crate's macros.</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.into_result' class='method'><code id='into_result.v'>fn <a href='#tymethod.into_result' class='fnname'>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>></code></h3><div class='docblock'><p>Convert this result into a <code>Result</code> for further processing / validation.</p>
|
||
</div></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.into_stream' class='method'><code id='into_stream.v'>fn <a href='#method.into_stream' class='fnname'>into_stream</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></h3><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></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-MacroResult-for-TokenStream' class='impl'><code class='in-band'>impl <a class="trait" href="../synstructure/trait.MacroResult.html" title="trait synstructure::MacroResult">MacroResult</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a></code><a href='#impl-MacroResult-for-TokenStream' class='anchor'></a><a class='srclink' href='../src/synstructure/lib.rs.html#2342-2350' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into_result' class="method hidden"><code id='into_result.v-1'>fn <a href='#method.into_result' class='fnname'>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>></code><a class='srclink' href='../src/synstructure/lib.rs.html#2343-2345' title='goto source code'>[src]</a></h4><h4 id='method.into_stream-1' class="method hidden"><code id='into_stream.v-1'>fn <a href='#method.into_stream' class='fnname'>into_stream</a>(self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/proc_macro/struct.TokenStream.html" title="struct proc_macro::TokenStream">TokenStream</a></code><a class='srclink' href='../src/synstructure/lib.rs.html#2347-2349' title='goto source code'>[src]</a></h4></div><h3 id='impl-MacroResult-for-TokenStream-1' class='impl'><code class='in-band'>impl <a class="trait" href="../synstructure/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></code><a href='#impl-MacroResult-for-TokenStream-1' class='anchor'></a><a class='srclink' href='../src/synstructure/lib.rs.html#2352-2356' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into_result-1' class="method hidden"><code id='into_result.v-2'>fn <a href='#method.into_result' class='fnname'>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>></code><a class='srclink' href='../src/synstructure/lib.rs.html#2353-2355' title='goto source code'>[src]</a></h4></div><h3 id='impl-MacroResult-for-Result%3CT%3E' class='impl'><code class='in-band'>impl<T: <a class="trait" href="../synstructure/trait.MacroResult.html" title="trait synstructure::MacroResult">MacroResult</a>> <a class="trait" href="../synstructure/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></code><a href='#impl-MacroResult-for-Result%3CT%3E' class='anchor'></a><a class='srclink' href='../src/synstructure/lib.rs.html#2358-2365' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into_result-2' class="method hidden"><code id='into_result.v-3'>fn <a href='#method.into_result' class='fnname'>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>></code><a class='srclink' href='../src/synstructure/lib.rs.html#2359-2364' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
||
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript" src="../implementors/synstructure/trait.MacroResult.js" async></script></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "synstructure";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |