2019-09-06 15:57:44 -07:00

32 lines
10 KiB
HTML
Raw Permalink 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 `hir` mod in crate `regex_syntax`."><meta name="keywords" content="rust, rustlang, rust-lang, hir"><title>regex_syntax::hir - 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">&#9776;</div><a href='../../regex_syntax/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module hir</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'><a href='../index.html'>regex_syntax</a></p><script>window.sidebarCurrent = {name: 'hir', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/regex_syntax/hir/mod.rs.html#1-2193' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>regex_syntax</a>::<wbr><a class="mod" href=''>hir</a></span></h1><div class='docblock'><p>Defines a high-level intermediate representation for regular expressions.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="literal/index.html" title='regex_syntax::hir::literal mod'>literal</a></td><td class='docblock-short'><p>Provides routines for extracting literal prefixes and suffixes from an <code>Hir</code>.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="print/index.html" title='regex_syntax::hir::print mod'>print</a></td><td class='docblock-short'><p>This module provides a regular expression printer for <code>Hir</code>.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="translate/index.html" title='regex_syntax::hir::translate mod'>translate</a></td><td class='docblock-short'><p>Defines a translator that converts an <code>Ast</code> to an <code>Hir</code>.</p>
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.ClassBytes.html" title='regex_syntax::hir::ClassBytes struct'>ClassBytes</a></td><td class='docblock-short'><p>A set of characters represented by arbitrary bytes (where one byte
corresponds to one character).</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassBytesIter.html" title='regex_syntax::hir::ClassBytesIter struct'>ClassBytesIter</a></td><td class='docblock-short'><p>An iterator over all ranges in a byte character class.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassBytesRange.html" title='regex_syntax::hir::ClassBytesRange struct'>ClassBytesRange</a></td><td class='docblock-short'><p>A single range of characters represented by arbitrary bytes.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassUnicode.html" title='regex_syntax::hir::ClassUnicode struct'>ClassUnicode</a></td><td class='docblock-short'><p>A set of characters represented by Unicode scalar values.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassUnicodeIter.html" title='regex_syntax::hir::ClassUnicodeIter struct'>ClassUnicodeIter</a></td><td class='docblock-short'><p>An iterator over all ranges in a Unicode character class.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassUnicodeRange.html" title='regex_syntax::hir::ClassUnicodeRange struct'>ClassUnicodeRange</a></td><td class='docblock-short'><p>A single range of characters represented by Unicode scalar values.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Error.html" title='regex_syntax::hir::Error struct'>Error</a></td><td class='docblock-short'><p>An error that can occur while translating an <code>Ast</code> to a <code>Hir</code>.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Group.html" title='regex_syntax::hir::Group struct'>Group</a></td><td class='docblock-short'><p>The high-level intermediate representation for a group.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Hir.html" title='regex_syntax::hir::Hir struct'>Hir</a></td><td class='docblock-short'><p>A high-level intermediate representation (HIR) for a regular expression.</p>
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Repetition.html" title='regex_syntax::hir::Repetition struct'>Repetition</a></td><td class='docblock-short'><p>The high-level intermediate representation of a repetition operator.</p>
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.Anchor.html" title='regex_syntax::hir::Anchor enum'>Anchor</a></td><td class='docblock-short'><p>The high-level intermediate representation for an anchor assertion.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Class.html" title='regex_syntax::hir::Class enum'>Class</a></td><td class='docblock-short'><p>The high-level intermediate representation of a character class.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ErrorKind.html" title='regex_syntax::hir::ErrorKind enum'>ErrorKind</a></td><td class='docblock-short'><p>The type of an error that occurred while building an <code>Hir</code>.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.GroupKind.html" title='regex_syntax::hir::GroupKind enum'>GroupKind</a></td><td class='docblock-short'><p>The kind of group.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.HirKind.html" title='regex_syntax::hir::HirKind enum'>HirKind</a></td><td class='docblock-short'><p>The kind of an arbitrary <code>Hir</code> expression.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Literal.html" title='regex_syntax::hir::Literal enum'>Literal</a></td><td class='docblock-short'><p>The high-level intermediate representation of a literal.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.RepetitionKind.html" title='regex_syntax::hir::RepetitionKind enum'>RepetitionKind</a></td><td class='docblock-short'><p>The kind of a repetition operator.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.RepetitionRange.html" title='regex_syntax::hir::RepetitionRange enum'>RepetitionRange</a></td><td class='docblock-short'><p>The kind of a counted repetition operator.</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.WordBoundary.html" title='regex_syntax::hir::WordBoundary enum'>WordBoundary</a></td><td class='docblock-short'><p>The high-level intermediate representation for a word-boundary assertion.</p>
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.Visitor.html" title='regex_syntax::hir::Visitor trait'>Visitor</a></td><td class='docblock-short'><p>A trait for visiting the high-level IR (HIR) in depth first order.</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.html" title='regex_syntax::hir::visit fn'>visit</a></td><td class='docblock-short'><p>Executes an implementation of <code>Visitor</code> in constant stack space.</p>
</td></tr></table></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>