mirror of
https://github.com/fluencelabs/wasmer
synced 2025-07-31 15:22:03 +00:00
104 lines
46 KiB
HTML
104 lines
46 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 `visit` mod in crate `syn`."><meta name="keywords" content="rust, rustlang, rust-lang, visit"><title>syn::visit - 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="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></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><a href='../../syn/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module visit</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>syn</a></p><script>window.sidebarCurrent = {name: 'visit', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><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/gen/visit.rs.html#4-3792' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>syn</a>::<wbr><a class="mod" href=''>visit</a></span></h1><div class='docblock'><p>Syntax tree traversal to walk a shared borrow of a syntax tree.</p>
|
|||
|
|
<p>Each method of the <a href="../../syn/visit/trait.Visit.html"><code>Visit</code></a> trait is a hook that can be overridden to
|
|||
|
|
customize the behavior when visiting the corresponding type of node. By
|
|||
|
|
default, every method recursively visits the substructure of the input
|
|||
|
|
by invoking the right visitor method of each of its fields.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">Visit</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> {
|
|||
|
|
<span class="comment">/* ... */</span>
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">visit_expr_binary</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">node</span>: <span class="kw-2">&</span><span class="lifetime">'ast</span> <span class="ident">ExprBinary</span>) {
|
|||
|
|
<span class="ident">visit_expr_binary</span>(<span class="self">self</span>, <span class="ident">node</span>);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="comment">/* ... */</span>
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">visit_expr_binary</span><span class="op"><</span><span class="lifetime">'ast</span>, <span class="ident">V</span><span class="op">></span>(<span class="ident">v</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">V</span>, <span class="ident">node</span>: <span class="kw-2">&</span><span class="lifetime">'ast</span> <span class="ident">ExprBinary</span>)
|
|||
|
|
<span class="kw">where</span>
|
|||
|
|
<span class="ident">V</span>: <span class="ident">Visit</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> <span class="op">+</span> <span class="question-mark">?</span><span class="ident">Sized</span>,
|
|||
|
|
{
|
|||
|
|
<span class="kw">for</span> <span class="ident">attr</span> <span class="kw">in</span> <span class="kw-2">&</span><span class="ident">node</span>.<span class="ident">attrs</span> {
|
|||
|
|
<span class="ident">v</span>.<span class="ident">visit_attribute</span>(<span class="ident">attr</span>);
|
|||
|
|
}
|
|||
|
|
<span class="ident">v</span>.<span class="ident">visit_expr</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">node</span>.<span class="ident">left</span>);
|
|||
|
|
<span class="ident">v</span>.<span class="ident">visit_bin_op</span>(<span class="kw-2">&</span><span class="ident">node</span>.<span class="ident">op</span>);
|
|||
|
|
<span class="ident">v</span>.<span class="ident">visit_expr</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">node</span>.<span class="ident">right</span>);
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="comment">/* ... */</span></pre></div>
|
|||
|
|
<p><em>This module is available if Syn is built with the <code>"visit"</code> feature.</em></p>
|
|||
|
|
<br>
|
|||
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|||
|
|
<p>This visitor will print the name of every freestanding function in the
|
|||
|
|
syntax tree, including nested functions.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="comment">// [dependencies]</span>
|
|||
|
|
<span class="comment">// quote = "1.0"</span>
|
|||
|
|
<span class="comment">// syn = { version = "1.0", features = ["full", "visit"] }</span>
|
|||
|
|
|
|||
|
|
<span class="kw">use</span> <span class="ident">quote</span>::<span class="ident">quote</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">syn</span>::<span class="ident">visit</span>::{<span class="self">self</span>, <span class="ident">Visit</span>};
|
|||
|
|
<span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">File</span>, <span class="ident">ItemFn</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">FnVisitor</span>;
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> <span class="ident">Visit</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> <span class="kw">for</span> <span class="ident">FnVisitor</span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">visit_item_fn</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">node</span>: <span class="kw-2">&</span><span class="lifetime">'ast</span> <span class="ident">ItemFn</span>) {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Function with name={}"</span>, <span class="ident">node</span>.<span class="ident">sig</span>.<span class="ident">ident</span>);
|
|||
|
|
|
|||
|
|
<span class="comment">// Delegate to the default impl to visit any nested functions.</span>
|
|||
|
|
<span class="ident">visit</span>::<span class="ident">visit_item_fn</span>(<span class="self">self</span>, <span class="ident">node</span>);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">code</span> <span class="op">=</span> <span class="macro">quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">f</span>() {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">g</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">syntax_tree</span>: <span class="ident">File</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse2</span>(<span class="ident">code</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="ident">FnVisitor</span>.<span class="ident">visit_file</span>(<span class="kw-2">&</span><span class="ident">syntax_tree</span>);
|
|||
|
|
}</pre></div>
|
|||
|
|
<p>The <code>'ast</code> lifetime on the input references means that the syntax tree
|
|||
|
|
outlives the complete recursive visit call, so the visitor is allowed to
|
|||
|
|
hold on to references into the syntax tree.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|||
|
|
<span class="kw">use</span> <span class="ident">quote</span>::<span class="ident">quote</span>;
|
|||
|
|
<span class="kw">use</span> <span class="ident">syn</span>::<span class="ident">visit</span>::{<span class="self">self</span>, <span class="ident">Visit</span>};
|
|||
|
|
<span class="kw">use</span> <span class="ident">syn</span>::{<span class="ident">File</span>, <span class="ident">ItemFn</span>};
|
|||
|
|
|
|||
|
|
<span class="kw">struct</span> <span class="ident">FnVisitor</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> {
|
|||
|
|
<span class="ident">functions</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'ast</span> <span class="ident">ItemFn</span><span class="op">></span>,
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> <span class="ident">Visit</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> <span class="kw">for</span> <span class="ident">FnVisitor</span><span class="op"><</span><span class="lifetime">'ast</span><span class="op">></span> {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">visit_item_fn</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">node</span>: <span class="kw-2">&</span><span class="lifetime">'ast</span> <span class="ident">ItemFn</span>) {
|
|||
|
|
<span class="self">self</span>.<span class="ident">functions</span>.<span class="ident">push</span>(<span class="ident">node</span>);
|
|||
|
|
<span class="ident">visit</span>::<span class="ident">visit_item_fn</span>(<span class="self">self</span>, <span class="ident">node</span>);
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
<span class="kw">fn</span> <span class="ident">main</span>() {
|
|||
|
|
<span class="kw">let</span> <span class="ident">code</span> <span class="op">=</span> <span class="macro">quote</span><span class="macro">!</span> {
|
|||
|
|
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">f</span>() {
|
|||
|
|
<span class="kw">fn</span> <span class="ident">g</span>() {}
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
<span class="kw">let</span> <span class="ident">syntax_tree</span>: <span class="ident">File</span> <span class="op">=</span> <span class="ident">syn</span>::<span class="ident">parse2</span>(<span class="ident">code</span>).<span class="ident">unwrap</span>();
|
|||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">visitor</span> <span class="op">=</span> <span class="ident">FnVisitor</span> { <span class="ident">functions</span>: <span class="ident">Vec</span>::<span class="ident">new</span>() };
|
|||
|
|
<span class="ident">visitor</span>.<span class="ident">visit_file</span>(<span class="kw-2">&</span><span class="ident">syntax_tree</span>);
|
|||
|
|
<span class="kw">for</span> <span class="ident">f</span> <span class="kw">in</span> <span class="ident">visitor</span>.<span class="ident">functions</span> {
|
|||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"Function with name={}"</span>, <span class="ident">f</span>.<span class="ident">sig</span>.<span class="ident">ident</span>);
|
|||
|
|
}
|
|||
|
|
}</pre></div>
|
|||
|
|
</div><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.Visit.html" title='syn::visit::Visit trait'>Visit</a></td><td class='docblock-short'><p>Syntax tree traversal to walk a shared borrow of a syntax tree.</p>
|
|||
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|||
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.visit_abi.html" title='syn::visit::visit_abi fn'>visit_abi</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_angle_bracketed_generic_arguments.html" title='syn::visit::visit_angle_bracketed_generic_arguments fn'>visit_angle_bracketed_generic_arguments</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_arm.html" title='syn::visit::visit_arm fn'>visit_arm</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_attr_style.html" title='syn::visit::visit_attr_style fn'>visit_attr_style</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_attribute.html" title='syn::visit::visit_attribute fn'>visit_attribute</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_bare_fn_arg.html" title='syn::visit::visit_bare_fn_arg fn'>visit_bare_fn_arg</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_bin_op.html" title='syn::visit::visit_bin_op fn'>visit_bin_op</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_binding.html" title='syn::visit::visit_binding fn'>visit_binding</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_block.html" title='syn::visit::visit_block fn'>visit_block</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_bound_lifetimes.html" title='syn::visit::visit_bound_lifetimes fn'>visit_bound_lifetimes</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_const_param.html" title='syn::visit::visit_const_param fn'>visit_const_param</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_constraint.html" title='syn::visit::visit_constraint fn'>visit_constraint</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_data.html" title='syn::visit::visit_data fn'>visit_data</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_data_enum.html" title='syn::visit::visit_data_enum fn'>visit_data_enum</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_data_struct.html" title='syn::visit::visit_data_struct fn'>visit_data_struct</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_data_union.html" title='syn::visit::visit_data_union fn'>visit_data_union</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_derive_input.html" title='syn::visit::visit_derive_input fn'>visit_derive_input</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_expr.html" title='syn::visit::visit_expr fn'>visit_expr</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_expr_array.html" title='syn::visit::visit_expr_array fn'>visit_expr_array</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_expr_assign.html" title='syn::visit::visit_expr_assign fn'>visit_expr_assign</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_expr_assign_op.html" title='syn::visit::visit_expr_assign_op fn'>visit_expr_assign_op</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_expr_async.html" title='syn::visit::visit_expr_async fn'>visit_expr_async</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.visit_expr_await.html" title='syn::visit::visit_expr_await fn'>visit_expr_await</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href
|