edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-16 04:58:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/regex_syntax/hir/index.html
edg-l 5c4cbb28c1 deploy: 4a83cfd6f9
2024-02-13 06:38:44 +00:00

16 lines
12 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="Defines a high-level intermediate (HIR) representation for regular expressions."><title>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 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="../../regex_syntax/index.html">regex_syntax</a><span class="version">0.8.2</span></h2></div><h2 class="location"><a href="#">Module hir</a></h2><div class="sidebar-elems"><section><ul class="block"><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></section><h2><a href="../index.html">In crate regex_syntax</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>Module <a href="../index.html">regex_syntax</a>::<wbr><a class="mod" href="#">hir</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/mod.rs.html#1-3861">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>Defines a high-level intermediate (HIR) representation for regular expressions.</p>
<p>The HIR is represented by the <a href="struct.Hir.html" title="struct regex_syntax::hir::Hir"><code>Hir</code></a> type, and it principally constructed via
<a href="translate/index.html" title="mod regex_syntax::hir::translate">translation</a> from an <a href="../ast/enum.Ast.html" title="enum regex_syntax::ast::Ast"><code>Ast</code></a>. Alternatively, users
may use the smart constructors defined on <code>Hir</code> to build their own by hand. The
smart constructors simultaneously simplify and “optimize” the HIR, and are also
the same routines used by translation.</p>
<p>Most regex engines only have an HIR like this, and usually construct it
directly from the concrete syntax. This crate however first parses the
concrete syntax into an <code>Ast</code>, and only then creates the HIR from the <code>Ast</code>,
as mentioned above. It’s done this way to facilitate better error reporting,
and to have a structured representation of a regex that faithfully represents
its concrete syntax. Namely, while an <code>Hir</code> value can be converted back to an
equivalent regex pattern string, it is unlikely to look like the original due
to its simplified structure.</p>
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="literal/index.html" title="mod regex_syntax::hir::literal">literal</a></div><div class="desc docblock-short">Provides literal extraction from <code>Hir</code> expressions.</div></li><li><div class="item-name"><a class="mod" href="print/index.html" title="mod regex_syntax::hir::print">print</a></div><div class="desc docblock-short">This module provides a regular expression printer for <code>Hir</code>.</div></li><li><div class="item-name"><a class="mod" href="translate/index.html" title="mod regex_syntax::hir::translate">translate</a></div><div class="desc docblock-short">Defines a translator that converts an <code>Ast</code> to an <code>Hir</code>.</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Capture.html" title="struct regex_syntax::hir::Capture">Capture</a></div><div class="desc docblock-short">The high-level intermediate representation for a capturing group.</div></li><li><div class="item-name"><a class="struct" href="struct.CaseFoldError.html" title="struct regex_syntax::hir::CaseFoldError">CaseFoldError</a></div><div class="desc docblock-short">An error that occurs when Unicode-aware simple case folding fails.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassBytes.html" title="struct regex_syntax::hir::ClassBytes">ClassBytes</a></div><div class="desc docblock-short">A set of characters represented by arbitrary bytes.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassBytesIter.html" title="struct regex_syntax::hir::ClassBytesIter">ClassBytesIter</a></div><div class="desc docblock-short">An iterator over all ranges in a byte character class.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassBytesRange.html" title="struct regex_syntax::hir::ClassBytesRange">ClassBytesRange</a></div><div class="desc docblock-short">A single range of characters represented by arbitrary bytes.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassUnicode.html" title="struct regex_syntax::hir::ClassUnicode">ClassUnicode</a></div><div class="desc docblock-short">A set of characters represented by Unicode scalar values.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassUnicodeIter.html" title="struct regex_syntax::hir::ClassUnicodeIter">ClassUnicodeIter</a></div><div class="desc docblock-short">An iterator over all ranges in a Unicode character class.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassUnicodeRange.html" title="struct regex_syntax::hir::ClassUnicodeRange">ClassUnicodeRange</a></div><div class="desc docblock-short">A single range of characters represented by Unicode scalar values.</div></li><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct regex_syntax::hir::Error">Error</a></div><div class="desc docblock-short">An error that can occur while translating an <code>Ast</code> to a <code>Hir</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.Hir.html" title="struct regex_syntax::hir::Hir">Hir</a></div><div class="desc docblock-short">A high-level intermediate representation (HIR) for a regular expression.</div></li><li><div class="item-name"><a class="struct" href="struct.Literal.html" title="struct regex_syntax::hir::Literal">Literal</a></div><div class="desc docblock-short">The high-level intermediate representation of a literal.</div></li><li><div class="item-name"><a class="struct" href="struct.LookSet.html" title="struct regex_syntax::hir::LookSet">LookSet</a></div><div class="desc docblock-short">A set of look-around assertions.</div></li><li><div class="item-name"><a class="struct" href="struct.LookSetIter.html" title="struct regex_syntax::hir::LookSetIter">LookSetIter</a></div><div class="desc docblock-short">An iterator over all look-around assertions in a <a href="struct.LookSet.html" title="struct regex_syntax::hir::LookSet"><code>LookSet</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Properties.html" title="struct regex_syntax::hir::Properties">Properties</a></div><div class="desc docblock-short">A type that collects various properties of an HIR value.</div></li><li><div class="item-name"><a class="struct" href="struct.Repetition.html" title="struct regex_syntax::hir::Repetition">Repetition</a></div><div class="desc docblock-short">The high-level intermediate representation of a repetition operator.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Class.html" title="enum regex_syntax::hir::Class">Class</a></div><div class="desc docblock-short">The high-level intermediate representation of a character class.</div></li><li><div class="item-name"><a class="enum" href="enum.Dot.html" title="enum regex_syntax::hir::Dot">Dot</a></div><div class="desc docblock-short">A type describing the different flavors of <code>.</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.ErrorKind.html" title="enum regex_syntax::hir::ErrorKind">ErrorKind</a></div><div class="desc docblock-short">The type of an error that occurred while building an <code>Hir</code>.</div></li><li><div class="item-name"><a class="enum" href="enum.HirKind.html" title="enum regex_syntax::hir::HirKind">HirKind</a></div><div class="desc docblock-short">The underlying kind of an arbitrary <a href="struct.Hir.html" title="struct regex_syntax::hir::Hir"><code>Hir</code></a> expression.</div></li><li><div class="item-name"><a class="enum" href="enum.Look.html" title="enum regex_syntax::hir::Look">Look</a></div><div class="desc docblock-short">The high-level intermediate representation for a look-around assertion.</div></li></ul><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.Visitor.html" title="trait regex_syntax::hir::Visitor">Visitor</a></div><div class="desc docblock-short">A trait for visiting the high-level IR (HIR) in depth first order.</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.html" title="fn regex_syntax::hir::visit">visit</a></div><div class="desc docblock-short">Executes an implementation of <code>Visitor</code> in constant stack space.</div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink