<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="Defines an abstract syntax for regular expressions."><title>regex_syntax::ast - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="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.77.0 (aedd173a2 2024-03-17)"data-channel="1.77.0"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="../sidebar-items.js"></script><scriptdefersrc="../../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../regex_syntax/index.html">regex_syntax</a><spanclass="version">0.8.2</span></h2></div><h2class="location"><ahref="#">Module ast</a></h2><divclass="sidebar-elems"><section><ulclass="block"><li><ahref="#modules">Modules</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#traits">Traits</a></li><li><ahref="#functions">Functions</a></li></ul></section><h2><ahref="../index.html">In crate regex_syntax</a></h2></div></nav><divclass="sidebar-resizer"></div>
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../regex_syntax/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Module <ahref="../index.html">regex_syntax</a>::<wbr><aclass="mod"href="#">ast</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/regex_syntax/ast/mod.rs.html#1-1809">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>Defines an abstract syntax for regular expressions.</p>
</div></details><h2id="modules"class="section-header">Modules<ahref="#modules"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="parse/index.html"title="mod regex_syntax::ast::parse">parse</a></div><divclass="desc docblock-short">This module provides a regular expression parser.</div></li><li><divclass="item-name"><aclass="mod"href="print/index.html"title="mod regex_syntax::ast::print">print</a></div><divclass="desc docblock-short">This module provides a regular expression printer for <code>Ast</code>.</div></li></ul><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.Alternation.html"title="struct regex_syntax::ast::Alternation">Alternation</a></div><divclass="desc docblock-short">An alternation of regular expressions.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Assertion.html"title="struct regex_syntax::ast::Assertion">Assertion</a></div><divclass="desc docblock-short">A single zero-width assertion.</div></li><li><divclass="item-name"><aclass="struct"href="struct.CaptureName.html"title="struct regex_syntax::ast::CaptureName">CaptureName</a></div><divclass="desc docblock-short">A capture name.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ClassAscii.html"title="struct regex_syntax::ast::ClassAscii">ClassAscii</a></div><divclass="desc docblock-short">An ASCII character class.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ClassBracketed.html"title="struct regex_syntax::ast::ClassBracketed">ClassBracketed</a></div><divclass="desc docblock-short">A bracketed character class, e.g., <code>[a-z0-9]</code>.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ClassPerl.html"title="struct regex_syntax::ast::ClassPerl">ClassPerl</a></div><divclass="desc docblock-short">A Perl character class.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ClassSetBinaryOp.html"title="struct regex_syntax::ast::ClassSetBinaryOp">ClassSetBinaryOp</a></div><divclass="desc docblock-short">A Unicode character class set operation.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ClassSetRange.html"title="struct regex_syntax::ast::ClassSetRange">ClassSetRange</a></div><divclass="desc docblock-short">A single character class range in a set.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ClassSetUnion.html"title="struct regex_syntax::ast::ClassSetUnion">ClassSetUnion</a></div><divclass="desc docblock-short">A union of items inside a character class set.</div></li><li><divclass="item-name"><aclass="struct"href="struct.ClassUnicode.html"title="struct regex_syntax::ast::ClassUnicode">ClassUnicode</a></div><divclass="desc docblock-short">A Unicode character class.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Comment.html"title="struct regex_syntax::ast::Comment">Comment</a></div><divclass="desc docblock-short">A comment from a regular expression with an associated span.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Concat.html"title="struct regex_syntax::ast::Concat">Concat</a></div><divclass="desc docblock-short">A concatenation of regular expressions.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Error.html"title="struct regex_syntax::ast::Error">Error</a></div><divclass="desc docblock-short">An error that occurred while parsing a regular expression into an abstract
syntax tree.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Flags.html"title="struct regex_syntax::ast::Flags">Flags</a></div><divclass="desc docblock-short">A group of flags.</div></li><li><divclass="item-name"><aclass="struct"href="struct.FlagsItem.html"title="struct regex_syntax::ast::FlagsItem">FlagsItem</a></div><divclass="desc docblock-short">A single item in a group of flags.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Group.html"title="struct regex_syntax::ast::Group">Group</a></div><divclass="desc docblock-short">A grouped regular expression.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Literal.html"title="struct regex_syntax::ast::Literal">Literal</a></div><divclass="desc docblock-short">A single literal expression.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Position.html"title="struct regex_syntax::ast::Position">Position</a></div><divclass="desc docblock-short">A single position in a regular expression.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Repetition.html"title="struct regex_syntax::ast::Repetition">Repetition</a></div><divclass="desc docblock-short">A repetition operation applied to a regular expression.</div></li><li><divclass="item-name"><aclass="struct"href="struct.RepetitionOp.html"title="struct regex_syntax::ast::RepetitionOp">RepetitionOp</a></div><divclass="desc docblock-short">The repetition operator itself.</div></li><li><divclass="item-name"><aclass="struct"href="struct.SetFlags.html"title="struct regex_syntax::ast::SetFlags">SetFlags</a></div><divclass="desc docblock-short">A group of flags that is not applied to a particular regular expression.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Span.html"title="struct regex_syntax::ast::Span">Span</a></div><divclass="desc docblock-short">Span represents the position information of a single AST item.</div></li><li><divclass="item-name"><aclass="struct"href="struct.WithComments.html"title="struct regex_syntax::ast::WithComments">WithComments</a></div><divclass="desc docblock-short">An abstract syntax tree for a singular expression along with comments
found.</div></li></ul><h2id="enums"class="section-header">Enums<ahref="#enums"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.AssertionKind.html"title="enum regex_syntax::ast::AssertionKind">AssertionKind</a></div><divclass="desc docblock-short">An assertion kind.</div></li><li><divclass="item-name"><aclass="enum"href="enum.Ast.html"title="enum regex_syntax::ast::Ast">Ast</a></div><divclass="desc docblock-short">An abstract syntax tree for a single regular expression.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ClassAsciiKind.html"title="enum regex_syntax::ast::ClassAsciiKind">ClassAsciiKind</a></div><divclass="desc docblock-short">The available ASCII character classes.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ClassPerlKind.html"title="enum regex_syntax::ast::ClassPerlKind">ClassPerlKind</a></div><divclass="desc docblock-short">The available Perl character classes.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ClassSet.html"title="enum regex_syntax::ast::ClassSet">ClassSet</a></div><divclass="desc docblock-short">A character class set.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ClassSetBinaryOpKind.html"title="enum regex_syntax::ast::ClassSetBinaryOpKind">ClassSetBinaryOpKind</a></div><divclass="desc docblock-short">The type of a Unicode character class set operation.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ClassSetItem.html"title="enum regex_syntax::ast::ClassSetItem">ClassSetItem</a></div><divclass="desc docblock-short">A single component of a character class set.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ClassUnicodeKind.html"title="enum regex_syntax::ast::ClassUnicodeKind">ClassUnicodeKind</a></div><divclass="desc docblock-short">The available forms of Unicode character classes.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ClassUnicodeOpKind.html"title="enum regex_syntax::ast::ClassUnicodeOpKind">ClassUnicodeOpKind</a></div><divclass="desc docblock-short">The type of op used in a Unicode character class.</div></li><li><divclass="item-name"><aclass="enum"href="enum.ErrorKind.html"title="enum regex_syntax::ast::ErrorKind">ErrorKind</a></div><divclass="desc docblock-short">The type of an error that occurred while building an AST.</div></li><li><divclass="item-name"><aclass="enum"href="enum.Flag.html"title="enum regex_syntax::ast::Flag">Flag</a></div><divclass="desc docblock-short">A single flag.</div></li><li><divclass="item-name"><aclass="enum"href="enum.FlagsItemKind.html"title="enum regex_syntax::ast::FlagsItemKind">FlagsItemKind</a></div><divclass="desc docblock-short">The kind of an item in a group of flags.</div></li><li><divclass="item-name"><aclass="enum"href="enum.GroupKind.html"title="enum regex_syntax::ast::GroupKind">GroupKind</a></div><divclass="desc docblock-short">The kind of a group.</div></li><li><divclass="item-name"><aclass="enum"href="enum.HexLiteralKind.html"title="enum regex_syntax::ast::HexLiteralKind">HexLiteralKind</a></div><divclass="desc docblock-short">The type of a Unicode hex literal.</div></li><li><divclass="item-name"><aclass="enum"href="enum.LiteralKind.html"title="enum regex_syntax::ast::LiteralKind">LiteralKind</a></div><divclass="desc docblock-short">The kind of a single literal expression.</div></li><li><divclass="item-name"><aclass="enum"href="enum.RepetitionKind.html"title="enum regex_syntax::ast::RepetitionKind">RepetitionKind</a></div><divclass="desc docblock-short">The kind of a repetition operator.</div></li><li><divclass="item-name"><aclass="enum"href="enum.RepetitionRange.html"title="enum regex_syntax::ast::RepetitionRange">RepetitionRange</a></div><divclass="desc docblock-short">A range repetition operator.</div></li><li><divclass="item-name"><aclass="enum"href="enum.SpecialLiteralKind.html"title="enum regex_syntax::ast::SpecialLiteralKind">SpecialLiteralKind</a></div><divclass="desc docblock-short">The typ
