edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-23 16:38:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/syn/visit_mut/index.html

77 lines
37 KiB
HTML
Raw Normal View History

deploy: d99059405e7534be8cc5d2d985d63e2d8daa2bcc
2024-03-02 09:26:34 +00:00
<!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="Syntax tree traversal to mutate an exclusive borrow of a syntax tree in place."><title>syn::visit_mut - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../syn/index.html">syn</a><span class="version">2.0.52</span></h2></div><h2 class="location"><a href="#">Module visit_mut</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section><h2><a href="../index.html">In crate syn</a></h2></div></nav><div class="sidebar-resizer"></div>
deploy: cc1e3679829ec7c574392bace9092ffa4ecb73c2
2024-02-27 06:59:44 +00:00
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../syn/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">syn</a>::<wbr><a class="mod" href="#">visit_mut</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/syn/gen/visit_mut.rs.html#4-3845">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Syntax tree traversal to mutate an exclusive borrow of a syntax tree in
deploy: 4a83cfd6f9c58b14a87234162281aad1aef83c3e
2024-02-13 06:38:44 +00:00
place.</p>
<p>Each method of the <a href="trait.VisitMut.html" title="trait syn::visit_mut::VisitMut"><code>VisitMut</code></a> trait is a hook that can be overridden
to customize the behavior when mutating 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"><code><span class="kw">pub trait </span>VisitMut {
<span class="comment">/* ... */
</span><span class="kw">fn </span>visit_expr_binary_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>, node: <span class="kw-2">&amp;mut </span>ExprBinary) {
visit_expr_binary_mut(<span class="self">self</span>, node);
}
<span class="comment">/* ... */
</span>}
<span class="kw">pub fn </span>visit_expr_binary_mut&lt;V&gt;(v: <span class="kw-2">&amp;mut </span>V, node: <span class="kw-2">&amp;mut </span>ExprBinary)
<span class="kw">where
</span>V: VisitMut + <span class="question-mark">?</span>Sized,
{
<span class="kw">for </span>attr <span class="kw">in </span><span class="kw-2">&amp;mut </span>node.attrs {
v.visit_attribute_mut(attr);
}
v.visit_expr_mut(<span class="kw-2">&amp;mut *</span>node.left);
v.visit_bin_op_mut(<span class="kw-2">&amp;mut </span>node.op);
v.visit_expr_mut(<span class="kw-2">&amp;mut *</span>node.right);
}
<span class="comment">/* ... */</span></code></pre></div>
<br>
<h2 id="example"><a href="#example">Example</a></h2>
<p>This mut visitor replace occurrences of u256 suffixed integer literals
like <code>999u256</code> with a macro invocation <code>bigint::u256!(999)</code>.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// [dependencies]
// quote = "1.0"
// syn = { version = "2.0", features = ["full", "visit-mut"] }
</span><span class="kw">use </span>quote::quote;
<span class="kw">use </span>syn::visit_mut::{<span class="self">self</span>, VisitMut};
<span class="kw">use </span>syn::{parse_quote, Expr, File, Lit, LitInt};
<span class="kw">struct </span>BigintReplace;
<span class="kw">impl </span>VisitMut <span class="kw">for </span>BigintReplace {
<span class="kw">fn </span>visit_expr_mut(<span class="kw-2">&amp;mut </span><span class="self">self</span>, node: <span class="kw-2">&amp;mut </span>Expr) {
<span class="kw">if let </span>Expr::Lit(expr) = <span class="kw-2">&amp;</span>node {
<span class="kw">if let </span>Lit::Int(int) = <span class="kw-2">&amp;</span>expr.lit {
<span class="kw">if </span>int.suffix() == <span class="string">"u256" </span>{
<span class="kw">let </span>digits = int.base10_digits();
<span class="kw">let </span>unsuffixed: LitInt = syn::parse_str(digits).unwrap();
<span class="kw-2">*</span>node = <span class="macro">parse_quote!</span>(<span class="macro">bigint::u256!</span>(#unsuffixed));
<span class="kw">return</span>;
}
}
}
<span class="comment">// Delegate to the default impl to visit nested expressions.
</span>visit_mut::visit_expr_mut(<span class="self">self</span>, node);
}
}
<span class="kw">fn </span>main() {
<span class="kw">let </span>code = <span class="macro">quote! </span>{
<span class="kw">fn </span>main() {
<span class="kw">let _ </span>= <span class="number">999u256</span>;
}
};
<span class="kw">let </span><span class="kw-2">mut </span>syntax_tree: File = syn::parse2(code).unwrap();
BigintReplace.visit_file_mut(<span class="kw-2">&amp;mut </span>syntax_tree);
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="macro">quote!</span>(#syntax_tree));
}</code></pre></div>
</div></details><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.VisitMut.html" title="trait syn::visit_mut::VisitMut">VisitMut</a></div><div class="desc docblock-short">Syntax tree traversal to mutate an exclusive borrow of a syntax tree in
place.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.visit_abi_mut.html" title="fn syn::visit_mut::visit_abi_mut">visit_abi_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_angle_bracketed_generic_arguments_mut.html" title="fn syn::visit_mut::visit_angle_bracketed_generic_arguments_mut">visit_angle_bracketed_generic_arguments_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_arm_mut.html" title="fn syn::visit_mut::visit_arm_mut">visit_arm_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_assoc_const_mut.html" title="fn syn::visit_mut::visit_assoc_const_mut">visit_assoc_const_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_assoc_type_mut.html" title="fn syn::visit_mut::visit_assoc_type_mut">visit_assoc_type_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_attr_style_mut.html" title="fn syn::visit_mut::visit_attr_style_mut">visit_attr_style_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_attribute_mut.html" title="fn syn::visit_mut::visit_attribute_mut">visit_attribute_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_bare_fn_arg_mut.html" title="fn syn::visit_mut::visit_bare_fn_arg_mut">visit_bare_fn_arg_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_bare_variadic_mut.html" title="fn syn::visit_mut::visit_bare_variadic_mut">visit_bare_variadic_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_bin_op_mut.html" title="fn syn::visit_mut::visit_bin_op_mut">visit_bin_op_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_block_mut.html" title="fn syn::visit_mut::visit_block_mut">visit_block_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_bound_lifetimes_mut.html" title="fn syn::visit_mut::visit_bound_lifetimes_mut">visit_bound_lifetimes_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_const_param_mut.html" title="fn syn::visit_mut::visit_const_param_mut">visit_const_param_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_constraint_mut.html" title="fn syn::visit_mut::visit_constraint_mut">visit_constraint_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_data_enum_mut.html" title="fn syn::visit_mut::visit_data_enum_mut">visit_data_enum_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_data_mut.html" title="fn syn::visit_mut::visit_data_mut">visit_data_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_data_struct_mut.html" title="fn syn::visit_mut::visit_data_struct_mut">visit_data_struct_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_data_union_mut.html" title="fn syn::visit_mut::visit_data_union_mut">visit_data_union_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_derive_input_mut.html" title="fn syn::visit_mut::visit_derive_input_mut">visit_derive_input_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_expr_array_mut.html" title="fn syn::visit_mut::visit_expr_array_mut">visit_expr_array_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_expr_assign_mut.html" title="fn syn::visit_mut::visit_expr_assign_mut">visit_expr_assign_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_expr_async_mut.html" title="fn syn::visit_mut::visit_expr_async_mut">visit_expr_async_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_expr_await_mut.html" title="fn syn::visit_mut::visit_expr_await_mut">visit_expr_await_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_expr_binary_mut.html" title="fn syn::visit_mut::visit_expr_binary_mut">visit_expr_binary_mut</a></div></li><li><div class="item-name"><a class="fn" href="fn.visit_expr_block_mut.html" title="fn syn::visit_mut::vi
Reference in a new issue Copy permalink