blob: 655f93e5dbb60112282a9b2dc04e8c11ed9bd096 [file] [log] [blame]
<!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 an abstract syntax for regular expressions."><meta name="keywords" content="rust, rustlang, rust-lang, ast"><title>regex_syntax::ast - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.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><a class="sidebar-logo" href="../../regex_syntax/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../regex_syntax/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module ast</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></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">regex_syntax</a>::<wbr><a class="mod" href="#">ast</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/regex_syntax/ast/mod.rs.html#1-1481">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines an abstract syntax for regular expressions.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="parse/index.html" title="regex_syntax::ast::parse mod">parse</a></div><div class="item-right docblock-short">This module provides a regular expression parser.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="print/index.html" title="regex_syntax::ast::print mod">print</a></div><div class="item-right docblock-short">This module provides a regular expression printer for <code>Ast</code>.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Alternation.html" title="regex_syntax::ast::Alternation struct">Alternation</a></div><div class="item-right docblock-short">An alternation of regular expressions.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Assertion.html" title="regex_syntax::ast::Assertion struct">Assertion</a></div><div class="item-right docblock-short">A single zero-width assertion.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.CaptureName.html" title="regex_syntax::ast::CaptureName struct">CaptureName</a></div><div class="item-right docblock-short">A capture name.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ClassAscii.html" title="regex_syntax::ast::ClassAscii struct">ClassAscii</a></div><div class="item-right docblock-short">An ASCII character class.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ClassBracketed.html" title="regex_syntax::ast::ClassBracketed struct">ClassBracketed</a></div><div class="item-right docblock-short">A bracketed character class, e.g., <code>[a-z0-9]</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ClassPerl.html" title="regex_syntax::ast::ClassPerl struct">ClassPerl</a></div><div class="item-right docblock-short">A Perl character class.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ClassSetBinaryOp.html" title="regex_syntax::ast::ClassSetBinaryOp struct">ClassSetBinaryOp</a></div><div class="item-right docblock-short">A Unicode character class set operation.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ClassSetRange.html" title="regex_syntax::ast::ClassSetRange struct">ClassSetRange</a></div><div class="item-right docblock-short">A single character class range in a set.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ClassSetUnion.html" title="regex_syntax::ast::ClassSetUnion struct">ClassSetUnion</a></div><div class="item-right docblock-short">A union of items inside a character class set.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ClassUnicode.html" title="regex_syntax::ast::ClassUnicode struct">ClassUnicode</a></div><div class="item-right docblock-short">A Unicode character class.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Comment.html" title="regex_syntax::ast::Comment struct">Comment</a></div><div class="item-right docblock-short">A comment from a regular expression with an associated span.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Concat.html" title="regex_syntax::ast::Concat struct">Concat</a></div><div class="item-right docblock-short">A concatenation of regular expressions.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Error.html" title="regex_syntax::ast::Error struct">Error</a></div><div class="item-right docblock-short">An error that occurred while parsing a regular expression into an abstract
syntax tree.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Flags.html" title="regex_syntax::ast::Flags struct">Flags</a></div><div class="item-right docblock-short">A group of flags.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.FlagsItem.html" title="regex_syntax::ast::FlagsItem struct">FlagsItem</a></div><div class="item-right docblock-short">A single item in a group of flags.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Group.html" title="regex_syntax::ast::Group struct">Group</a></div><div class="item-right docblock-short">A grouped regular expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Literal.html" title="regex_syntax::ast::Literal struct">Literal</a></div><div class="item-right docblock-short">A single literal expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Position.html" title="regex_syntax::ast::Position struct">Position</a></div><div class="item-right docblock-short">A single position in a regular expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Repetition.html" title="regex_syntax::ast::Repetition struct">Repetition</a></div><div class="item-right docblock-short">A repetition operation applied to a regular expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RepetitionOp.html" title="regex_syntax::ast::RepetitionOp struct">RepetitionOp</a></div><div class="item-right docblock-short">The repetition operator itself.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.SetFlags.html" title="regex_syntax::ast::SetFlags struct">SetFlags</a></div><div class="item-right docblock-short">A group of flags that is not applied to a particular regular expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Span.html" title="regex_syntax::ast::Span struct">Span</a></div><div class="item-right docblock-short">Span represents the position information of a single AST item.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.WithComments.html" title="regex_syntax::ast::WithComments struct">WithComments</a></div><div class="item-right docblock-short">An abstract syntax tree for a singular expression along with comments
found.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.AssertionKind.html" title="regex_syntax::ast::AssertionKind enum">AssertionKind</a></div><div class="item-right docblock-short">An assertion kind.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Ast.html" title="regex_syntax::ast::Ast enum">Ast</a></div><div class="item-right docblock-short">An abstract syntax tree for a single regular expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Class.html" title="regex_syntax::ast::Class enum">Class</a></div><div class="item-right docblock-short">A single character class expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ClassAsciiKind.html" title="regex_syntax::ast::ClassAsciiKind enum">ClassAsciiKind</a></div><div class="item-right docblock-short">The available ASCII character classes.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ClassPerlKind.html" title="regex_syntax::ast::ClassPerlKind enum">ClassPerlKind</a></div><div class="item-right docblock-short">The available Perl character classes.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ClassSet.html" title="regex_syntax::ast::ClassSet enum">ClassSet</a></div><div class="item-right docblock-short">A character class set.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ClassSetBinaryOpKind.html" title="regex_syntax::ast::ClassSetBinaryOpKind enum">ClassSetBinaryOpKind</a></div><div class="item-right docblock-short">The type of a Unicode character class set operation.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ClassSetItem.html" title="regex_syntax::ast::ClassSetItem enum">ClassSetItem</a></div><div class="item-right docblock-short">A single component of a character class set.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ClassUnicodeKind.html" title="regex_syntax::ast::ClassUnicodeKind enum">ClassUnicodeKind</a></div><div class="item-right docblock-short">The available forms of Unicode character classes.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ClassUnicodeOpKind.html" title="regex_syntax::ast::ClassUnicodeOpKind enum">ClassUnicodeOpKind</a></div><div class="item-right docblock-short">The type of op used in a Unicode character class.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ErrorKind.html" title="regex_syntax::ast::ErrorKind enum">ErrorKind</a></div><div class="item-right docblock-short">The type of an error that occurred while building an AST.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Flag.html" title="regex_syntax::ast::Flag enum">Flag</a></div><div class="item-right docblock-short">A single flag.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.FlagsItemKind.html" title="regex_syntax::ast::FlagsItemKind enum">FlagsItemKind</a></div><div class="item-right docblock-short">The kind of an item in a group of flags.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.GroupKind.html" title="regex_syntax::ast::GroupKind enum">GroupKind</a></div><div class="item-right docblock-short">The kind of a group.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.HexLiteralKind.html" title="regex_syntax::ast::HexLiteralKind enum">HexLiteralKind</a></div><div class="item-right docblock-short">The type of a Unicode hex literal.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LiteralKind.html" title="regex_syntax::ast::LiteralKind enum">LiteralKind</a></div><div class="item-right docblock-short">The kind of a single literal expression.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.RepetitionKind.html" title="regex_syntax::ast::RepetitionKind enum">RepetitionKind</a></div><div class="item-right docblock-short">The kind of a repetition operator.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.RepetitionRange.html" title="regex_syntax::ast::RepetitionRange enum">RepetitionRange</a></div><div class="item-right docblock-short">A range repetition operator.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.SpecialLiteralKind.html" title="regex_syntax::ast::SpecialLiteralKind enum">SpecialLiteralKind</a></div><div class="item-right docblock-short">The type of a special literal.</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Visitor.html" title="regex_syntax::ast::Visitor trait">Visitor</a></div><div class="item-right docblock-short">A trait for visiting an abstract syntax tree (AST) in depth first order.</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.visit.html" title="regex_syntax::ast::visit fn">visit</a></div><div class="item-right docblock-short">Executes an implementation of <code>Visitor</code> in constant stack space.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="regex_syntax" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>