mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-26 20:09:33 +01:00
16 lines
6.4 KiB
HTML
16 lines
6.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="A punctuated sequence of syntax tree nodes separated by punctuation."><title>syn::punctuated - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="syn" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></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="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../syn/index.html">syn</a><span class="version">1.0.109</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module punctuated</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate syn</a></h2></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">syn</a></span><h1>Module <span>punctuated</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/syn/punctuated.rs.html#1-1087">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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" title="struct syn::punctuated::Punctuated"><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>
|
||
|
|
<div class="example-wrap"><pre class="language-text"><code>a_function_call(arg1, arg2, arg3);
|
||
|
|
~~~~^ ~~~~^ ~~~~</code></pre></div></div></details><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.IntoIter.html" title="struct syn::punctuated::IntoIter">Into<wbr>Iter</a></div><div class="desc docblock-short">An iterator over owned values of type <code>T</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoPairs.html" title="struct syn::punctuated::IntoPairs">Into<wbr>Pairs</a></div><div class="desc docblock-short">An iterator over owned pairs of type <code>Pair<T, P></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Iter.html" title="struct syn::punctuated::Iter">Iter</a></div><div class="desc docblock-short">An iterator over borrowed values of type <code>&T</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IterMut.html" title="struct syn::punctuated::IterMut">IterMut</a></div><div class="desc docblock-short">An iterator over mutably borrowed values of type <code>&mut T</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Pairs.html" title="struct syn::punctuated::Pairs">Pairs</a></div><div class="desc docblock-short">An iterator over borrowed pairs of type <code>Pair<&T, &P></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.PairsMut.html" title="struct syn::punctuated::PairsMut">Pairs<wbr>Mut</a></div><div class="desc docblock-short">An iterator over mutably borrowed pairs of type <code>Pair<&mut T, &mut P></code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Punctuated.html" title="struct syn::punctuated::Punctuated">Punctuated</a></div><div class="desc docblock-short">A punctuated sequence of syntax tree nodes of type <code>T</code> separated by
|
||
|
|
punctuation of type <code>P</code>.</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.Pair.html" title="enum syn::punctuated::Pair">Pair</a></div><div class="desc docblock-short">A single syntax tree node of type <code>T</code> followed by its trailing punctuation
|
||
|
|
of type <code>P</code> if any.</div></li></ul></section></div></main></body></html>
|