Auto Generated Documentation
This commit is contained in:
github-actions[bot]
+22
-39
@@ -1,7 +1,6 @@
|
||||
<!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="A wrapper around the procedural macro API of the compiler’s `proc_macro` crate. This library serves two purposes:"><meta name="keywords" content="rust, rustlang, rust-lang, proc_macro2"><title>proc_macro2 - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script id="default-settings"></script><script src="../storage.js"></script><script src="../crates.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
|
||||
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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 href='../proc_macro2/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class="location">Crate proc_macro2</p><div class="block version"><p>Version 1.0.27</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all proc_macro2's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"></p><div id="sidebar-vars" data-name="proc_macro2" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><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><button type="button" class="help-button">?</button>
|
||||
<a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="">proc_macro2</a><button id="copy-path" onclick="copy_path(this)">⎘</button></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/proc_macro2/lib.rs.html#1-1272" title="goto source code">[src]</a></span></h1><div class="docblock"><p>A wrapper around the procedural macro API of the compiler’s <a href="https://doc.rust-lang.org/proc_macro/"><code>proc_macro</code></a>
|
||||
<!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="github crates-io docs-rs"><title>proc_macro2 - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="proc_macro2" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.1 (4eb161250 2025-03-15)" data-channel="1.85.1" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../proc_macro2/index.html">proc_<wbr>macro2</a><span class="version">1.0.94</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#usage" title="Usage">Usage</a></li><li><a href="#unstable-features" title="Unstable features">Unstable features</a></li><li><a href="#thread-safety" title="Thread-Safety">Thread-Safety</a></li></ul><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>proc_macro2</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/proc_macro2/lib.rs.html#1-1384">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="https://github.com/dtolnay/proc-macro2"><img src="https://img.shields.io/badge/github-8da0cb?style=for-the-badge&labelColor=555555&logo=github" alt="github" /></a> <a href="https://crates.io/crates/proc-macro2"><img src="https://img.shields.io/badge/crates.io-fc8d62?style=for-the-badge&labelColor=555555&logo=rust" alt="crates-io" /></a> <a href="index.html" title="mod proc_macro2"><img src="https://img.shields.io/badge/docs.rs-66c2a5?style=for-the-badge&labelColor=555555&logo=docs.rs" alt="docs-rs" /></a></p>
|
||||
<br>
|
||||
<p>A wrapper around the procedural macro API of the compiler’s <a href="https://doc.rust-lang.org/1.85.1/proc_macro/index.html" title="mod proc_macro"><code>proc_macro</code></a>
|
||||
crate. This library serves two purposes:</p>
|
||||
<ul>
|
||||
<li>
|
||||
@@ -22,59 +21,43 @@ a macro to be testable in isolation, they must be implemented using
|
||||
<code>proc_macro2</code>.</p>
|
||||
</li>
|
||||
</ul>
|
||||
<h1 id="usage" class="section-header"><a href="#usage">Usage</a></h1>
|
||||
<h2 id="usage"><a class="doc-anchor" href="#usage">§</a>Usage</h2>
|
||||
<p>The skeleton of a typical procedural macro typically looks like this:</p>
|
||||
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">proc_macro</span>;
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">extern crate </span>proc_macro;
|
||||
|
||||
<span class="attribute">#[<span class="ident">proc_macro_derive</span>(<span class="ident">MyDerive</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">my_derive</span>(<span class="ident">input</span>: <span class="ident">proc_macro::TokenStream</span>) <span class="op">-</span><span class="op">></span> <span class="ident">proc_macro::TokenStream</span> {
|
||||
<span class="kw">let</span> <span class="ident">input</span> <span class="op">=</span> <span class="ident">proc_macro2::TokenStream::from</span>(<span class="ident">input</span>);
|
||||
<span class="attr">#[proc_macro_derive(MyDerive)]
|
||||
</span><span class="kw">pub fn </span>my_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
|
||||
<span class="kw">let </span>input = proc_macro2::TokenStream::from(input);
|
||||
|
||||
<span class="kw">let</span> <span class="ident">output</span>: <span class="ident">proc_macro2::TokenStream</span> <span class="op">=</span> {
|
||||
<span class="comment">/* transform input */</span>
|
||||
};
|
||||
<span class="kw">let </span>output: proc_macro2::TokenStream = {
|
||||
<span class="comment">/* transform input */
|
||||
</span>};
|
||||
|
||||
<span class="ident">proc_macro::TokenStream::from</span>(<span class="ident">output</span>)
|
||||
}</pre></div>
|
||||
<p>If parsing with <a href="https://github.com/dtolnay/syn">Syn</a>, you’ll use <a href="https://docs.rs/syn/1.0/syn/macro.parse_macro_input.html"><code>parse_macro_input!</code></a> instead to
|
||||
proc_macro::TokenStream::from(output)
|
||||
}</code></pre></div>
|
||||
<p>If parsing with <a href="https://github.com/dtolnay/syn">Syn</a>, you’ll use <a href="https://docs.rs/syn/2.0/syn/macro.parse_macro_input.html"><code>parse_macro_input!</code></a> instead to
|
||||
propagate parse errors correctly back to the compiler when parsing fails.</p>
|
||||
<h1 id="unstable-features" class="section-header"><a href="#unstable-features">Unstable features</a></h1>
|
||||
<h2 id="unstable-features"><a class="doc-anchor" href="#unstable-features">§</a>Unstable features</h2>
|
||||
<p>The default feature set of proc-macro2 tracks the most recent stable
|
||||
compiler API. Functionality in <code>proc_macro</code> that is not yet stable is not
|
||||
exposed by proc-macro2 by default.</p>
|
||||
<p>To opt into the additional APIs available in the most recent nightly
|
||||
compiler, the <code>procmacro2_semver_exempt</code> config flag must be passed to
|
||||
rustc. We will polyfill those nightly-only APIs back to Rust 1.31.0. As
|
||||
rustc. We will polyfill those nightly-only APIs back to Rust 1.56.0. As
|
||||
these are unstable APIs that track the nightly compiler, minor versions of
|
||||
proc-macro2 may make breaking changes to them at any time.</p>
|
||||
<pre><code class="language-sh">RUSTFLAGS='--cfg procmacro2_semver_exempt' cargo build
|
||||
</code></pre>
|
||||
<div class="example-wrap"><pre class="language-sh"><code>RUSTFLAGS='--cfg procmacro2_semver_exempt' cargo build</code></pre></div>
|
||||
<p>Note that this must not only be done for your crate, but for any crate that
|
||||
depends on your crate. This infectious nature is intentional, as it serves
|
||||
as a reminder that you are outside of the normal semver guarantees.</p>
|
||||
<p>Semver exempt methods are marked as such in the proc-macro2 documentation.</p>
|
||||
<h1 id="thread-safety" class="section-header"><a href="#thread-safety">Thread-Safety</a></h1>
|
||||
<h2 id="thread-safety"><a class="doc-anchor" href="#thread-safety">§</a>Thread-Safety</h2>
|
||||
<p>Most types in this crate are <code>!Sync</code> because the underlying compiler
|
||||
types make use of thread-local memory, meaning they cannot be accessed from
|
||||
a different thread.</p>
|
||||
</div><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
|
||||
<table><tr class="module-item"><td><a class="mod" href="token_stream/index.html" title="proc_macro2::token_stream mod">token_stream</a></td><td class="docblock-short"><p>Public implementation details for the <code>TokenStream</code> type, such as iterators.</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.Group.html" title="proc_macro2::Group struct">Group</a></td><td class="docblock-short"><p>A delimited token stream.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Ident.html" title="proc_macro2::Ident struct">Ident</a></td><td class="docblock-short"><p>A word of Rust code, which may be a keyword or legal variable name.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LexError.html" title="proc_macro2::LexError struct">LexError</a></td><td class="docblock-short"><p>Error returned from <code>TokenStream::from_str</code>.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Literal.html" title="proc_macro2::Literal struct">Literal</a></td><td class="docblock-short"><p>A literal string (<code>"hello"</code>), byte string (<code>b"hello"</code>), character (<code>'a'</code>),
|
||||
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="extra/index.html" title="mod proc_macro2::extra">extra</a></div><div class="desc docblock-short">Items which do not have a correspondence to any API in the proc_macro crate,
|
||||
but are necessary to include in proc-macro2.</div></li><li><div class="item-name"><a class="mod" href="token_stream/index.html" title="mod proc_macro2::token_stream">token_<wbr>stream</a></div><div class="desc docblock-short">Public implementation details for the <code>TokenStream</code> type, such as iterators.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Group.html" title="struct proc_macro2::Group">Group</a></div><div class="desc docblock-short">A delimited token stream.</div></li><li><div class="item-name"><a class="struct" href="struct.Ident.html" title="struct proc_macro2::Ident">Ident</a></div><div class="desc docblock-short">A word of Rust code, which may be a keyword or legal variable name.</div></li><li><div class="item-name"><a class="struct" href="struct.LexError.html" title="struct proc_macro2::LexError">LexError</a></div><div class="desc docblock-short">Error returned from <code>TokenStream::from_str</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Literal.html" title="struct proc_macro2::Literal">Literal</a></div><div class="desc docblock-short">A literal string (<code>"hello"</code>), byte string (<code>b"hello"</code>), character (<code>'a'</code>),
|
||||
byte character (<code>b'a'</code>), an integer or floating point number with or without
|
||||
a suffix (<code>1</code>, <code>1u8</code>, <code>2.3</code>, <code>2.3f32</code>).</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Punct.html" title="proc_macro2::Punct struct">Punct</a></td><td class="docblock-short"><p>A <code>Punct</code> is a single punctuation character like <code>+</code>, <code>-</code> or <code>#</code>.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Span.html" title="proc_macro2::Span struct">Span</a></td><td class="docblock-short"><p>A region of source code, along with macro expansion information.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TokenStream.html" title="proc_macro2::TokenStream struct">TokenStream</a></td><td class="docblock-short"><p>An abstract stream of tokens, or more concretely a sequence of token trees.</p>
|
||||
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
|
||||
<table><tr class="module-item"><td><a class="enum" href="enum.Delimiter.html" title="proc_macro2::Delimiter enum">Delimiter</a></td><td class="docblock-short"><p>Describes how a sequence of token trees is delimited.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="enum" href="enum.Spacing.html" title="proc_macro2::Spacing enum">Spacing</a></td><td class="docblock-short"><p>Whether a <code>Punct</code> is followed immediately by another <code>Punct</code> or followed by
|
||||
another token or whitespace.</p>
|
||||
</td></tr><tr class="module-item"><td><a class="enum" href="enum.TokenTree.html" title="proc_macro2::TokenTree enum">TokenTree</a></td><td class="docblock-short"><p>A single token or a delimited sequence of token trees (e.g. <code>[1, (), ..]</code>).</p>
|
||||
</td></tr></table></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="proc_macro2" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
|
||||
<script src="../main.js"></script></body></html>
|
||||
a suffix (<code>1</code>, <code>1u8</code>, <code>2.3</code>, <code>2.3f32</code>).</div></li><li><div class="item-name"><a class="struct" href="struct.Punct.html" title="struct proc_macro2::Punct">Punct</a></div><div class="desc docblock-short">A <code>Punct</code> is a single punctuation character like <code>+</code>, <code>-</code> or <code>#</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Span.html" title="struct proc_macro2::Span">Span</a></div><div class="desc docblock-short">A region of source code, along with macro expansion information.</div></li><li><div class="item-name"><a class="struct" href="struct.TokenStream.html" title="struct proc_macro2::TokenStream">Token<wbr>Stream</a></div><div class="desc docblock-short">An abstract stream of tokens, or more concretely a sequence of token trees.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Delimiter.html" title="enum proc_macro2::Delimiter">Delimiter</a></div><div class="desc docblock-short">Describes how a sequence of token trees is delimited.</div></li><li><div class="item-name"><a class="enum" href="enum.Spacing.html" title="enum proc_macro2::Spacing">Spacing</a></div><div class="desc docblock-short">Whether a <code>Punct</code> is followed immediately by another <code>Punct</code> or followed by
|
||||
another token or whitespace.</div></li><li><div class="item-name"><a class="enum" href="enum.TokenTree.html" title="enum proc_macro2::TokenTree">Token<wbr>Tree</a></div><div class="desc docblock-short">A single token or a delimited sequence of token trees (e.g. <code>[1, (), ..]</code>).</div></li></ul></section></div></main></body></html>
|
||||
Reference in New Issue
Block a user