210 lines
No EOL
9.4 KiB
HTML
210 lines
No EOL
9.4 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 `punctuated` mod in crate `syn`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, punctuated">
|
||
|
||
<title>syn::punctuated - 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 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">
|
||
<div class="sidebar-menu">☰</div>
|
||
|
||
<p class='location'>Module punctuated</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class='location'><a href='../index.html'>syn</a></p><script>window.sidebarCurrent = {name: 'punctuated', ty: 'mod', 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'>Module <a href='../index.html'>syn</a>::<wbr><a class="mod" href=''>punctuated</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/syn/punctuated.rs.html#9-807' title='goto source code'>[src]</a></span></h1>
|
||
<div class='docblock'><p>A punctuated sequence of syntax tree nodes separated by punctuation.</p>
|
||
<p>Lots of things in Rust are punctuated sequences.</p>
|
||
<ul>
|
||
<li>The fields of a struct are <code>Punctuated<Field, Token![,]></code>.</li>
|
||
<li>The segments of a path are <code>Punctuated<PathSegment, Token![::]></code>.</li>
|
||
<li>The bounds on a generic parameter are <code>Punctuated<TypeParamBound, Token![+]></code>.</li>
|
||
<li>The arguments to a function call are <code>Punctuated<Expr, Token![,]></code>.</li>
|
||
</ul>
|
||
<p>This module provides a common representation for these punctuated sequences
|
||
in the form of the <a href="struct.Punctuated.html"><code>Punctuated<T, P></code></a> type. We store a vector of pairs of
|
||
syntax tree node + punctuation, where every node in the sequence is followed
|
||
by punctuation except for possibly the final one.</p>
|
||
<pre><code class="language-text">a_function_call(arg1, arg2, arg3);
|
||
^^^^^ ~~~~~ ^^^^
|
||
</code></pre>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.IntoIter.html"
|
||
title='struct syn::punctuated::IntoIter'>IntoIter</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An iterator over owned values of type <code>T</code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.IntoPairs.html"
|
||
title='struct syn::punctuated::IntoPairs'>IntoPairs</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An iterator over owned pairs of type <code>Pair<T, P></code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Iter.html"
|
||
title='struct syn::punctuated::Iter'>Iter</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An iterator over borrowed values of type <code>&T</code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.IterMut.html"
|
||
title='struct syn::punctuated::IterMut'>IterMut</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An iterator over mutably borrowed values of type <code>&mut T</code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Pairs.html"
|
||
title='struct syn::punctuated::Pairs'>Pairs</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An iterator over borrowed pairs of type <code>Pair<&T, &P></code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.PairsMut.html"
|
||
title='struct syn::punctuated::PairsMut'>PairsMut</a></td>
|
||
<td class='docblock-short'>
|
||
<p>An iterator over mutably borrowed pairs of type <code>Pair<&mut T, &mut P></code>.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.Punctuated.html"
|
||
title='struct syn::punctuated::Punctuated'>Punctuated</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A punctuated sequence of syntax tree nodes of type <code>T</code> separated by
|
||
punctuation of type <code>P</code>.</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.Pair.html"
|
||
title='enum syn::punctuated::Pair'>Pair</a></td>
|
||
<td class='docblock-short'>
|
||
<p>A single syntax tree node of type <code>T</code> followed by its trailing punctuation
|
||
of type <code>P</code> if any.</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><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 = "syn";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |