owoify/target/doc/regex_syntax/hir/trait.Visitor.html

34 lines
13 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `Visitor` trait in crate `regex_syntax`."><meta name="keywords" content="rust, rustlang, rust-lang, Visitor"><title>regex_syntax::hir::Visitor - 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 trait"><!--[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">&#9776;</div><a href='../../regex_syntax/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait Visitor</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Output">Output</a><a href="#associatedtype.Err">Err</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.finish">finish</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.start">start</a><a href="#method.visit_alternation_in">visit_alternation_in</a><a href="#method.visit_post">visit_post</a><a href="#method.visit_pre">visit_pre</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>regex_syntax</a>::<wbr><a href='index.html'>hir</a></p><script>window.sidebarCurrent = {name: 'Visitor', ty: 'trait', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/regex_syntax/hir/visitor.rs.html#23-52' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>regex_syntax</a>::<wbr><a href='index.html'>hir</a>::<wbr><a class="trait" href=''>Visitor</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Visitor {
type <a href='#associatedtype.Output' class="type">Output</a>;
type <a href='#associatedtype.Err' class="type">Err</a>;
fn <a href='#tymethod.finish' class='fnname'>finish</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Output" title="type regex_syntax::hir::Visitor::Output">Output</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt;;
fn <a href='#method.start' class='fnname'>start</a>(&amp;mut self) { ... }
<div class='item-spacer'></div> fn <a href='#method.visit_pre' class='fnname'>visit_pre</a>(&amp;mut self, _hir: &amp;<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt; { ... }
<div class='item-spacer'></div> fn <a href='#method.visit_post' class='fnname'>visit_post</a>(&amp;mut self, _hir: &amp;<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt; { ... }
<div class='item-spacer'></div> fn <a href='#method.visit_alternation_in' class='fnname'>visit_alternation_in</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt; { ... }
}</pre></div><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"><code>visit</code></a> function.</p>
</div>
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Output' class='method'><code id='Output.t'>type <a href='#associatedtype.Output' class="type">Output</a></code></h3><div class='docblock'><p>The result of visiting an HIR.</p>
</div><h3 id='associatedtype.Err' class='method'><code id='Err.t'>type <a href='#associatedtype.Err' class="type">Err</a></code></h3><div class='docblock'><p>An error that visiting an HIR might return.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.finish' class='method'><code id='finish.v'>fn <a href='#tymethod.finish' class='fnname'>finish</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Output" title="type regex_syntax::hir::Visitor::Output">Output</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt;</code></h3><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></div><span class='loading-content'>Loading content...</span>
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.start' class='method'><code id='start.v'>fn <a href='#method.start' class='fnname'>start</a>(&amp;mut self)</code></h3><div class='docblock'><p>This method is called before beginning traversal of the HIR.</p>
</div><h3 id='method.visit_pre' class='method'><code id='visit_pre.v'>fn <a href='#method.visit_pre' class='fnname'>visit_pre</a>(&amp;mut self, _hir: &amp;<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt;</code></h3><div class='docblock'><p>This method is called on an <code>Hir</code> before descending into child <code>Hir</code>
nodes.</p>
</div><h3 id='method.visit_post' class='method'><code id='visit_post.v'>fn <a href='#method.visit_post' class='fnname'>visit_post</a>(&amp;mut self, _hir: &amp;<a class="struct" href="../../regex_syntax/hir/struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt;</code></h3><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><h3 id='method.visit_alternation_in' class='method'><code id='visit_alternation_in.v'>fn <a href='#method.visit_alternation_in' class='fnname'>visit_alternation_in</a>(&amp;mut self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Self::<a class="type" href="../../regex_syntax/hir/trait.Visitor.html#associatedtype.Err" title="type regex_syntax::hir::Visitor::Err">Err</a>&gt;</code></h3><div class='docblock'><p>This method is called between child nodes of an alternation.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
src="../../implementors/regex_syntax/hir/trait.Visitor.js">
</script></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>&#9166;</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "regex_syntax";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>