55 lines
15 KiB
HTML
55 lines
15 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="API documentation for the Rust `ast` mod in crate `regex_syntax`."><meta name="keywords" content="rust, rustlang, rust-lang, ast"><title>regex_syntax::ast - 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">☰</div><a href='../../regex_syntax/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module ast</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: 'ast', 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'>−</span>]</a></span><a class='srclink' href='../../src/regex_syntax/ast/mod.rs.html#11-1524' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>regex_syntax</a>::<wbr><a class="mod" href=''>ast</a></span></h1><div class='docblock'><p>Defines an abstract syntax 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="parse/index.html" title='regex_syntax::ast::parse mod'>parse</a></td><td class='docblock-short'><p>This module provides a regular expression parser.</p>
|
||
</td></tr><tr class='module-item'><td><a class="mod" href="print/index.html" title='regex_syntax::ast::print mod'>print</a></td><td class='docblock-short'><p>This module provides a regular expression printer for <code>Ast</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.Alternation.html" title='regex_syntax::ast::Alternation struct'>Alternation</a></td><td class='docblock-short'><p>An alternation of regular expressions.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Assertion.html" title='regex_syntax::ast::Assertion struct'>Assertion</a></td><td class='docblock-short'><p>A single zero-width assertion.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.CaptureName.html" title='regex_syntax::ast::CaptureName struct'>CaptureName</a></td><td class='docblock-short'><p>A capture name.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassAscii.html" title='regex_syntax::ast::ClassAscii struct'>ClassAscii</a></td><td class='docblock-short'><p>An ASCII character class.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassBracketed.html" title='regex_syntax::ast::ClassBracketed struct'>ClassBracketed</a></td><td class='docblock-short'><p>A bracketed character class, e.g., <code>[a-z0-9]</code>.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassPerl.html" title='regex_syntax::ast::ClassPerl struct'>ClassPerl</a></td><td class='docblock-short'><p>A Perl character class.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassSetBinaryOp.html" title='regex_syntax::ast::ClassSetBinaryOp struct'>ClassSetBinaryOp</a></td><td class='docblock-short'><p>A Unicode character class set operation.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassSetRange.html" title='regex_syntax::ast::ClassSetRange struct'>ClassSetRange</a></td><td class='docblock-short'><p>A single character class range in a set.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassSetUnion.html" title='regex_syntax::ast::ClassSetUnion struct'>ClassSetUnion</a></td><td class='docblock-short'><p>A union of items inside a character class set.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ClassUnicode.html" title='regex_syntax::ast::ClassUnicode struct'>ClassUnicode</a></td><td class='docblock-short'><p>A Unicode character class.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Comment.html" title='regex_syntax::ast::Comment struct'>Comment</a></td><td class='docblock-short'><p>A comment from a regular expression with an associated span.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Concat.html" title='regex_syntax::ast::Concat struct'>Concat</a></td><td class='docblock-short'><p>A concatenation of regular expressions.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Error.html" title='regex_syntax::ast::Error struct'>Error</a></td><td class='docblock-short'><p>An error that occurred while parsing a regular expression into an abstract
|
||
syntax tree.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Flags.html" title='regex_syntax::ast::Flags struct'>Flags</a></td><td class='docblock-short'><p>A group of flags.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.FlagsItem.html" title='regex_syntax::ast::FlagsItem struct'>FlagsItem</a></td><td class='docblock-short'><p>A single item in a group of flags.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Group.html" title='regex_syntax::ast::Group struct'>Group</a></td><td class='docblock-short'><p>A grouped regular expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Literal.html" title='regex_syntax::ast::Literal struct'>Literal</a></td><td class='docblock-short'><p>A single literal expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Position.html" title='regex_syntax::ast::Position struct'>Position</a></td><td class='docblock-short'><p>A single position in a regular expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Repetition.html" title='regex_syntax::ast::Repetition struct'>Repetition</a></td><td class='docblock-short'><p>A repetition operation applied to a regular expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.RepetitionOp.html" title='regex_syntax::ast::RepetitionOp struct'>RepetitionOp</a></td><td class='docblock-short'><p>The repetition operator itself.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.SetFlags.html" title='regex_syntax::ast::SetFlags struct'>SetFlags</a></td><td class='docblock-short'><p>A group of flags that is not applied to a particular regular expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Span.html" title='regex_syntax::ast::Span struct'>Span</a></td><td class='docblock-short'><p>Span represents the position information of a single AST item.</p>
|
||
</td></tr><tr class='module-item'><td><a class="struct" href="struct.WithComments.html" title='regex_syntax::ast::WithComments struct'>WithComments</a></td><td class='docblock-short'><p>An abstract syntax tree for a singular expression along with comments
|
||
found.</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.AssertionKind.html" title='regex_syntax::ast::AssertionKind enum'>AssertionKind</a></td><td class='docblock-short'><p>An assertion kind.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Ast.html" title='regex_syntax::ast::Ast enum'>Ast</a></td><td class='docblock-short'><p>An abstract syntax tree for a single regular expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Class.html" title='regex_syntax::ast::Class enum'>Class</a></td><td class='docblock-short'><p>A single character class expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ClassAsciiKind.html" title='regex_syntax::ast::ClassAsciiKind enum'>ClassAsciiKind</a></td><td class='docblock-short'><p>The available ASCII character classes.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ClassPerlKind.html" title='regex_syntax::ast::ClassPerlKind enum'>ClassPerlKind</a></td><td class='docblock-short'><p>The available Perl character classes.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ClassSet.html" title='regex_syntax::ast::ClassSet enum'>ClassSet</a></td><td class='docblock-short'><p>A character class set.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ClassSetBinaryOpKind.html" title='regex_syntax::ast::ClassSetBinaryOpKind enum'>ClassSetBinaryOpKind</a></td><td class='docblock-short'><p>The type of a Unicode character class set operation.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ClassSetItem.html" title='regex_syntax::ast::ClassSetItem enum'>ClassSetItem</a></td><td class='docblock-short'><p>A single component of a character class set.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ClassUnicodeKind.html" title='regex_syntax::ast::ClassUnicodeKind enum'>ClassUnicodeKind</a></td><td class='docblock-short'><p>The available forms of Unicode character classes.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ClassUnicodeOpKind.html" title='regex_syntax::ast::ClassUnicodeOpKind enum'>ClassUnicodeOpKind</a></td><td class='docblock-short'><p>The type of op used in a Unicode character class.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.ErrorKind.html" title='regex_syntax::ast::ErrorKind enum'>ErrorKind</a></td><td class='docblock-short'><p>The type of an error that occurred while building an AST.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.Flag.html" title='regex_syntax::ast::Flag enum'>Flag</a></td><td class='docblock-short'><p>A single flag.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.FlagsItemKind.html" title='regex_syntax::ast::FlagsItemKind enum'>FlagsItemKind</a></td><td class='docblock-short'><p>The kind of an item in a group of flags.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.GroupKind.html" title='regex_syntax::ast::GroupKind enum'>GroupKind</a></td><td class='docblock-short'><p>The kind of a group.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.HexLiteralKind.html" title='regex_syntax::ast::HexLiteralKind enum'>HexLiteralKind</a></td><td class='docblock-short'><p>The type of a Unicode hex literal.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.LiteralKind.html" title='regex_syntax::ast::LiteralKind enum'>LiteralKind</a></td><td class='docblock-short'><p>The kind of a single literal expression.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.RepetitionKind.html" title='regex_syntax::ast::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::ast::RepetitionRange enum'>RepetitionRange</a></td><td class='docblock-short'><p>A range repetition operator.</p>
|
||
</td></tr><tr class='module-item'><td><a class="enum" href="enum.SpecialLiteralKind.html" title='regex_syntax::ast::SpecialLiteralKind enum'>SpecialLiteralKind</a></td><td class='docblock-short'><p>The type of a special literal.</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::ast::Visitor trait'>Visitor</a></td><td class='docblock-short'><p>A trait for visiting an abstract syntax tree (AST) 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::ast::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>⏎</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> |