173 lines
16 KiB
HTML
173 lines
16 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 `Punct` struct in crate `proc_macro2`.">
|
|||
|
|
<meta name="keywords" content="rust, rustlang, rust-lang, Punct">
|
|||
|
|
|
|||
|
|
<title>proc_macro2::Punct - 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="../main.css" id="themeStyle">
|
|||
|
|
<script src="../storage.js"></script>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
<body class="rustdoc struct">
|
|||
|
|
<!--[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>
|
|||
|
|
|
|||
|
|
<p class='location'>Struct Punct</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.as_char">as_char</a><a href="#method.spacing">spacing</a><a href="#method.span">span</a><a href="#method.set_span">set_span</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3CPunct%3E">From<Punct></a><a href="#impl-Clone">Clone</a><a href="#impl-Display">Display</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='index.html'>proc_macro2</a></p><script>window.sidebarCurrent = {name: 'Punct', ty: 'struct', 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 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'>Struct <a href='index.html'>proc_macro2</a>::<wbr><a class="struct" href=''>Punct</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/proc_macro2/lib.rs.html#603-607' title='goto source code'>[src]</a></span></h1>
|
|||
|
|
<pre class='rust struct'>pub struct Punct { /* fields omitted */ }</pre><div class='docblock'><p>An <code>Punct</code> is an single punctuation character like <code>+</code>, <code>-</code> or <code>#</code>.</p>
|
|||
|
|
<p>Multicharacter operators like <code>+=</code> are represented as two instances of
|
|||
|
|
<code>Punct</code> with different forms of <code>Spacing</code> returned.</p>
|
|||
|
|
</div>
|
|||
|
|
<h2 id='methods' class='small-section-header'>
|
|||
|
|
Methods<a href='#methods' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl' class='impl'><span class='in-band'><code>impl <a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#622-661' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(op: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>, spacing: <a class="enum" href="../proc_macro2/enum.Spacing.html" title="enum proc_macro2::Spacing">Spacing</a>) -> <a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#630-636' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Creates a new <code>Punct</code> from the given character and spacing.</p>
|
|||
|
|
<p>The <code>ch</code> argument must be a valid punctuation character permitted by the
|
|||
|
|
language, otherwise the function will panic.</p>
|
|||
|
|
<p>The returned <code>Punct</code> will have the default span of <code>Span::call_site()</code>
|
|||
|
|
which can be further configured with the <code>set_span</code> method below.</p>
|
|||
|
|
</div><h4 id='method.as_char' class="method"><span id='as_char.v' class='invisible'><code>pub fn <a href='#method.as_char' class='fnname'>as_char</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#639-641' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns the value of this punctuation character as <code>char</code>.</p>
|
|||
|
|
</div><h4 id='method.spacing' class="method"><span id='spacing.v' class='invisible'><code>pub fn <a href='#method.spacing' class='fnname'>spacing</a>(&self) -> <a class="enum" href="../proc_macro2/enum.Spacing.html" title="enum proc_macro2::Spacing">Spacing</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#648-650' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns the spacing of this punctuation character, indicating whether
|
|||
|
|
it's immediately followed by another <code>Punct</code> in the token stream, so
|
|||
|
|
they can potentially be combined into a multicharacter operator
|
|||
|
|
(<code>Joint</code>), or it's followed by some other token or whitespace (<code>Alone</code>)
|
|||
|
|
so the operator has certainly ended.</p>
|
|||
|
|
</div><h4 id='method.span' class="method"><span id='span.v' class='invisible'><code>pub fn <a href='#method.span' class='fnname'>span</a>(&self) -> <a class="struct" href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span">Span</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#653-655' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns the span for this punctuation character.</p>
|
|||
|
|
</div><h4 id='method.set_span' class="method"><span id='set_span.v' class='invisible'><code>pub fn <a href='#method.set_span' class='fnname'>set_span</a>(&mut self, span: <a class="struct" href="../proc_macro2/struct.Span.html" title="struct proc_macro2::Span">Span</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#658-660' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Configure the span for this punctuation character.</p>
|
|||
|
|
</div></div>
|
|||
|
|
<h2 id='implementations' class='small-section-header'>
|
|||
|
|
Trait Implementations<a href='#implementations' class='anchor'></a>
|
|||
|
|
</h2>
|
|||
|
|
<h3 id='impl-From%3CPunct%3E' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a>> for <a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a></code><a href='#impl-From%3CPunct%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#446-450' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(g: <a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a>) -> <a class="enum" href="../proc_macro2/enum.TokenTree.html" title="enum proc_macro2::TokenTree">TokenTree</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#447-449' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs the conversion.</p>
|
|||
|
|
</div></div><h3 id='impl-Clone' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#602' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#602' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|||
|
|
</div><h4 id='method.clone_from' class="method"><span id='clone_from.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code></span><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Display' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a> for <a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a></code><a href='#impl-Display' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#665-669' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='docblock'><p>Prints the punctuation character as a string that should be losslessly
|
|||
|
|
convertible back into the same character.</p>
|
|||
|
|
</div><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#666-668' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Display.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../proc_macro2/struct.Punct.html" title="struct proc_macro2::Punct">Punct</a></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#671-680' title='goto source code'>[src]</a></span></h3>
|
|||
|
|
<div class='impl-items'><h4 id='method.fmt-1' class="method"><span id='fmt.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/proc_macro2/lib.rs.html#672-679' title='goto source code'>[src]</a></span></h4>
|
|||
|
|
<div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|||
|
|
</div></div></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><kbd>?</kbd></dt>
|
|||
|
|
<dd>Show this help dialog</dd>
|
|||
|
|
<dt><kbd>S</kbd></dt>
|
|||
|
|
<dd>Focus the search field</dd>
|
|||
|
|
<dt><kbd>↑</kbd></dt>
|
|||
|
|
<dd>Move up in search results</dd>
|
|||
|
|
<dt><kbd>↓</kbd></dt>
|
|||
|
|
<dd>Move down in search results</dd>
|
|||
|
|
<dt><kbd>↹</kbd></dt>
|
|||
|
|
<dd>Switch tab</dd>
|
|||
|
|
<dt><kbd>⏎</kbd></dt>
|
|||
|
|
<dd>Go to active search result</dd>
|
|||
|
|
<dt><kbd>+</kbd></dt>
|
|||
|
|
<dd>Expand all sections</dd>
|
|||
|
|
<dt><kbd>-</kbd></dt>
|
|||
|
|
<dd>Collapse 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 = "proc_macro2";
|
|||
|
|
</script>
|
|||
|
|
<script src="../main.js"></script>
|
|||
|
|
<script defer src="../search-index.js"></script>
|
|||
|
|
</body>
|
|||
|
|
</html>
|