mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-14 03:58:23 +00:00
34 lines
14 KiB
HTML
34 lines
14 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 trait for visiting the high-level IR (HIR) in depth first order."><title>Visitor in regex_syntax::hir - 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="regex_syntax" 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 trait"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../regex_syntax/index.html">regex_syntax</a><span class="version">0.8.2</span></h2></div><h2 class="location"><a href="#">Visitor</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Err">Err</a></li><li><a href="#associatedtype.Output">Output</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.finish">finish</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.start">start</a></li><li><a href="#method.visit_alternation_in">visit_alternation_in</a></li><li><a href="#method.visit_concat_in">visit_concat_in</a></li><li><a href="#method.visit_post">visit_post</a></li><li><a href="#method.visit_pre">visit_pre</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In regex_syntax::hir</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|||
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../regex_syntax/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>Trait <a href="../index.html">regex_syntax</a>::<wbr><a href="index.html">hir</a>::<wbr><a class="trait" href="#">Visitor</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/regex_syntax/hir/visitor.rs.html#15-49">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Visitor {
|
|||
|
|
type <a href="#associatedtype.Output" class="associatedtype">Output</a>;
|
|||
|
|
type <a href="#associatedtype.Err" class="associatedtype">Err</a>;
|
|||
|
|
|
|||
|
|
// Required method
|
|||
|
|
fn <a href="#tymethod.finish" class="fn">finish</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Output" title="type regex_syntax::hir::Visitor::Output">Output</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>>;
|
|||
|
|
|
|||
|
|
// Provided methods
|
|||
|
|
fn <a href="#method.start" class="fn">start</a>(&mut self) { ... }
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#method.visit_pre" class="fn">visit_pre</a>(&mut self, _hir: &<a class="struct" href="struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>> { ... }
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#method.visit_post" class="fn">visit_post</a>(&mut self, _hir: &<a class="struct" href="struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>> { ... }
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#method.visit_alternation_in" class="fn">visit_alternation_in</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>> { ... }
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#method.visit_concat_in" class="fn">visit_concat_in</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>> { ... }
|
|||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for visiting the high-level IR (HIR) in depth first order.</p>
|
|||
|
|
<p>The principle aim of this trait is to enable callers to perform case
|
|||
|
|
analysis on a high-level intermediate representation of a regular
|
|||
|
|
expression without necessarily using recursion. In particular, this permits
|
|||
|
|
callers to do case analysis with constant stack usage, which can be
|
|||
|
|
important since the size of an HIR may be proportional to end user input.</p>
|
|||
|
|
<p>Typical usage of this trait involves providing an implementation and then
|
|||
|
|
running it using the <a href="fn.visit.html" title="fn regex_syntax::hir::visit"><code>visit</code></a> function.</p>
|
|||
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Output" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#17">source</a><h4 class="code-header">type <a href="#associatedtype.Output" class="associatedtype">Output</a></h4></section></summary><div class="docblock"><p>The result of visiting an HIR.</p>
|
|||
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.Err" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#19">source</a><h4 class="code-header">type <a href="#associatedtype.Err" class="associatedtype">Err</a></h4></section></summary><div class="docblock"><p>An error that visiting an HIR might return.</p>
|
|||
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.finish" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#23">source</a><h4 class="code-header">fn <a href="#tymethod.finish" class="fn">finish</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Output" title="type regex_syntax::hir::Visitor::Output">Output</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>></h4></section></summary><div class="docblock"><p>All implementors of <code>Visitor</code> must provide a <code>finish</code> method, which
|
|||
|
|
yields the result of visiting the HIR or an error.</p>
|
|||
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.start" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#26">source</a><h4 class="code-header">fn <a href="#method.start" class="fn">start</a>(&mut self)</h4></section></summary><div class="docblock"><p>This method is called before beginning traversal of the HIR.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.visit_pre" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#30-32">source</a><h4 class="code-header">fn <a href="#method.visit_pre" class="fn">visit_pre</a>(&mut self, _hir: &<a class="struct" href="struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>></h4></section></summary><div class="docblock"><p>This method is called on an <code>Hir</code> before descending into child <code>Hir</code>
|
|||
|
|
nodes.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.visit_post" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#36-38">source</a><h4 class="code-header">fn <a href="#method.visit_post" class="fn">visit_post</a>(&mut self, _hir: &<a class="struct" href="struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>></h4></section></summary><div class="docblock"><p>This method is called on an <code>Hir</code> after descending all of its child
|
|||
|
|
<code>Hir</code> nodes.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.visit_alternation_in" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#41-43">source</a><h4 class="code-header">fn <a href="#method.visit_alternation_in" class="fn">visit_alternation_in</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>></h4></section></summary><div class="docblock"><p>This method is called between child nodes of an alternation.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.visit_concat_in" class="method"><a class="src rightside" href="../../src/regex_syntax/hir/visitor.rs.html#46-48">source</a><h4 class="code-header">fn <a href="#method.visit_concat_in" class="fn">visit_concat_in</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>></h4></section></summary><div class="docblock"><p>This method is called between child nodes of a concatenation.</p>
|
|||
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../trait.impl/regex_syntax/hir/visitor/trait.Visitor.js" async></script></section></div></main></body></html>
|