214 lines
8.8 KiB
HTML
214 lines
8.8 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 `quote` crate.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, quote">
|
|||
|
|
|
|||
|
|
<title>quote - Rust</title>
|
|||
|
|
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
|
|||
|
|
<link rel="stylesheet" type="text/css" href="../main.css">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc mod">
|
|||
|
|
<!--[if lte IE 8]>
|
|||
|
|
<div class="warning">
|
|||
|
|
This old browser is unsupported and will most likely display funky
|
|||
|
|
things.
|
|||
|
|
</div>
|
|||
|
|
<![endif]-->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<nav class="sidebar">
|
|||
|
|
|
|||
|
|
<p class='location'>Crate quote</p><div class="block items"><ul><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'quote', ty: 'mod', relpath: '../'};</script>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<nav class="sub">
|
|||
|
|
<form class="search-form js-only">
|
|||
|
|
<div class="search-container">
|
|||
|
|
<input class="search-input" name="search"
|
|||
|
|
autocomplete="off"
|
|||
|
|
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
|||
|
|
type="search">
|
|||
|
|
</div>
|
|||
|
|
</form>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section id='main' class="content">
|
|||
|
|
<h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>quote</a></span><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/quote/lib.rs.html#1-252' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<div class='docblock'><p>Quasi-quoting without a Syntex dependency, intended for use with <a href="https://github.com/rust-lang/rfcs/blob/master/text/1681-macros-1.1.md">Macros
|
|||
|
|
1.1</a>.</p>
|
|||
|
|
|
|||
|
|
<pre><code class="language-toml">[dependencies]
|
|||
|
|
quote = "0.3"
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
<pre class="rust rust-example-rendered">
|
|||
|
|
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
|||
|
|
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">quote</span>;</pre>
|
|||
|
|
|
|||
|
|
<p>Interpolation is done with <code>#var</code>:</p>
|
|||
|
|
|
|||
|
|
<pre><code class="language-text">let tokens = quote! {
|
|||
|
|
struct SerializeWith #generics #where_clause {
|
|||
|
|
value: &'a #field_ty,
|
|||
|
|
phantom: ::std::marker::PhantomData<#item_ty>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
impl #generics serde::Serialize for SerializeWith #generics #where_clause {
|
|||
|
|
fn serialize<S>(&self, s: &mut S) -> Result<(), S::Error>
|
|||
|
|
where S: serde::Serializer
|
|||
|
|
{
|
|||
|
|
#path(self.value, s)
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
SerializeWith {
|
|||
|
|
value: #value,
|
|||
|
|
phantom: ::std::marker::PhantomData::<#item_ty>,
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
<p>Repetition is done using <code>#(...)*</code> or <code>#(...),*</code> very similar to <code>macro_rules!</code>:</p>
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li><code>#(#var)*</code> - no separators</li>
|
|||
|
|
<li><code>#(#var),*</code> - the character before the asterisk is used as a separator</li>
|
|||
|
|
<li><code>#( struct #var; )*</code> - the repetition can contain other things</li>
|
|||
|
|
<li><code>#( #k => println!("{}", #v), )*</code> - even multiple interpolations</li>
|
|||
|
|
</ul>
|
|||
|
|
|
|||
|
|
<p>The return type of <code>quote!</code> is <code>quote::Tokens</code>. Tokens can be interpolated into
|
|||
|
|
other quotes:</p>
|
|||
|
|
|
|||
|
|
<pre><code class="language-text">let t = quote! { /* ... */ };
|
|||
|
|
return quote! { /* ... */ #t /* ... */ };
|
|||
|
|
</code></pre>
|
|||
|
|
|
|||
|
|
<p>Call <code>to_string()</code> or <code>as_str()</code> on a Tokens to get a <code>String</code> or <code>&str</code> of Rust
|
|||
|
|
code.</p>
|
|||
|
|
|
|||
|
|
<p>The <code>quote!</code> macro relies on deep recursion so some large invocations may fail
|
|||
|
|
with "recursion limit reached" when you compile. If it fails, bump up the
|
|||
|
|
recursion limit by adding <code>#![recursion_limit = "128"]</code> to your crate. An even
|
|||
|
|
higher limit may be necessary for especially large invocations.</p>
|
|||
|
|
</div><h2 id='macros' class='section-header'><a href="#macros">Macros</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="macro" href="macro.quote.html"
|
|||
|
|
title='macro quote::quote'>quote</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>The whole point.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.ByteStr.html"
|
|||
|
|
title='struct quote::ByteStr'>ByteStr</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Wrap a <code>&str</code> so it interpolates as a byte-string: <code>b"abc"</code>.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Hex.html"
|
|||
|
|
title='struct quote::Hex'>Hex</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Wrap an integer so it interpolates as a hexadecimal.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Ident.html"
|
|||
|
|
title='struct quote::Ident'>Ident</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>An identifier that should be interpolated without quotes.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="struct" href="struct.Tokens.html"
|
|||
|
|
title='struct quote::Tokens'>Tokens</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Tokens produced by a <code>quote!(...)</code> invocation.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table>
|
|||
|
|
<tr class=' module-item'>
|
|||
|
|
<td><a class="trait" href="trait.ToTokens.html"
|
|||
|
|
title='trait quote::ToTokens'>ToTokens</a></td>
|
|||
|
|
<td class='docblock-short'>
|
|||
|
|
<p>Types that can be interpolated inside a <code>quote!(...)</code> invocation.</p>
|
|||
|
|
</td>
|
|||
|
|
</tr></table></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>?</dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt>S</dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt>⇤</dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt>⇥</dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt>⏎</dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt>+</dt>
|
|||
|
|
<dd>Collapse/expand 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>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</aside>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<script>
|
|||
|
|
window.rootPath = "../";
|
|||
|
|
window.currentCrate = "quote";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|