edlang/regex_syntax/ast/index.html

5 lines
15 KiB
HTML
Raw Normal View History

<!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."><title>regex_syntax::ast - 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-5bc39a1768837dd0.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.77.1 (7cf61ebde 2024-03-27)" data-channel="1.77.1" data-search-js="search-dd67cee4cfa65049.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-4c98445ec4002617.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-48f368f3872407c8.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-04d5337699b92874.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../regex_syntax/index.html">regex_syntax</a><span class="version">0.8.3</span></h2></div><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><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="#">ast</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/ast/mod.rs.html#1-1809">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 an abstract syntax for regular expressions.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="parse/index.html" title="mod regex_syntax::ast::parse">parse</a></div><div class="desc docblock-short">This module provides a regular expression parser.</div></li><li><div class="item-name"><a class="mod" href="print/index.html" title="mod regex_syntax::ast::print">print</a></div><div class="desc docblock-short">This module provides a regular expression printer for <code>Ast</code>.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Alternation.html" title="struct regex_syntax::ast::Alternation">Alternation</a></div><div class="desc docblock-short">An alternation of regular expressions.</div></li><li><div class="item-name"><a class="struct" href="struct.Assertion.html" title="struct regex_syntax::ast::Assertion">Assertion</a></div><div class="desc docblock-short">A single zero-width assertion.</div></li><li><div class="item-name"><a class="struct" href="struct.CaptureName.html" title="struct regex_syntax::ast::CaptureName">CaptureName</a></div><div class="desc docblock-short">A capture name.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassAscii.html" title="struct regex_syntax::ast::ClassAscii">ClassAscii</a></div><div class="desc docblock-short">An ASCII character class.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassBracketed.html" title="struct regex_syntax::ast::ClassBracketed">ClassBracketed</a></div><div class="desc docblock-short">A bracketed character class, e.g., <code>[a-z0-9]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassPerl.html" title="struct regex_syntax::ast::ClassPerl">ClassPerl</a></div><div class="desc docblock-short">A Perl character class.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassSetBinaryOp.html" title="struct regex_syntax::ast::ClassSetBinaryOp">ClassSetBinaryOp</a></div><div class="desc docblock-short">A Unicode character class set operation.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassSetRange.html" title="struct regex_syntax::ast::ClassSetRange">ClassSetRange</a></div><div class="desc docblock-short">A single character class range in a set.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassSetUnion.html" title="struct regex_syntax::ast::ClassSetUnion">ClassSetUnion</a></div><div class="desc docblock-short">A union of items inside a character class set.</div></li><li><div class="item-name"><a class="struct" href="struct.ClassUnicode.html" title="struct regex_syntax::ast::ClassUnicode">ClassUnicode</a></div><div class="desc docblock-short">A Unicode character class.</div></li><li><div class="item-name"><a class="struct" href="struct.Comment.html" title="struct regex_syntax::ast::Comment">Comment</a></div><div class="desc docblock-short">A comment from a regular expression with an associated span.</div></li><li><div class="item-name"><a class="struct" href="struct.Concat.html" title="struct regex_syntax::ast::Concat">Concat</a></div><div class="desc docblock-short">A concatenation of regular expressions.</div></li><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct regex_syntax::ast::Error">Error</a></div><div class="desc docblock-short">An error that occurred while parsing a regular expression into an abstract
syntax tree.</div></li><li><div class="item-name"><a class="struct" href="struct.Flags.html" title="struct regex_syntax::ast::Flags">Flags</a></div><div class="desc docblock-short">A group of flags.</div></li><li><div class="item-name"><a class="struct" href="struct.FlagsItem.html" title="struct regex_syntax::ast::FlagsItem">FlagsItem</a></div><div class="desc docblock-short">A single item in a group of flags.</div></li><li><div class="item-name"><a class="struct" href="struct.Group.html" title="struct regex_syntax::ast::Group">Group</a></div><div class="desc docblock-short">A grouped regular expression.</div></li><li><div class="item-name"><a class="struct" href="struct.Literal.html" title="struct regex_syntax::ast::Literal">Literal</a></div><div class="desc docblock-short">A single literal expression.</div></li><li><div class="item-name"><a class="struct" href="struct.Position.html" title="struct regex_syntax::ast::Position">Position</a></div><div class="desc docblock-short">A single position in a regular expression.</div></li><li><div class="item-name"><a class="struct" href="struct.Repetition.html" title="struct regex_syntax::ast::Repetition">Repetition</a></div><div class="desc docblock-short">A repetition operation applied to a regular expression.</div></li><li><div class="item-name"><a class="struct" href="struct.RepetitionOp.html" title="struct regex_syntax::ast::RepetitionOp">RepetitionOp</a></div><div class="desc docblock-short">The repetition operator itself.</div></li><li><div class="item-name"><a class="struct" href="struct.SetFlags.html" title="struct regex_syntax::ast::SetFlags">SetFlags</a></div><div class="desc docblock-short">A group of flags that is not applied to a particular regular expression.</div></li><li><div class="item-name"><a class="struct" href="struct.Span.html" title="struct regex_syntax::ast::Span">Span</a></div><div class="desc docblock-short">Span represents the position information of a single AST item.</div></li><li><div class="item-name"><a class="struct" href="struct.WithComments.html" title="struct regex_syntax::ast::WithComments">WithComments</a></div><div class="desc docblock-short">An abstract syntax tree for a singular expression along with comments
found.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AssertionKind.html" title="enum regex_syntax::ast::AssertionKind">AssertionKind</a></div><div class="desc docblock-short">An assertion kind.</div></li><li><div class="item-name"><a class="enum" href="enum.Ast.html" title="enum regex_syntax::ast::Ast">Ast</a></div><div class="desc docblock-short">An abstract syntax tree for a single regular expression.</div></li><li><div class="item-name"><a class="enum" href="enum.ClassAsciiKind.html" title="enum regex_syntax::ast::ClassAsciiKind">ClassAsciiKind</a></div><div class="desc docblock-short">The available ASCII character classes.</div></li><li><div class="item-name"><a class="enum" href="enum.ClassPerlKind.html" title="enum regex_syntax::ast::ClassPerlKind">ClassPerlKind</a></div><div class="desc docblock-short">The available Perl character classes.</div></li><li><div class="item-name"><a class="enum" href="enum.ClassSet.html" title="enum regex_syntax::ast::ClassSet">ClassSet</a></div><div class="desc docblock-short">A character class set.</div></li><li><div class="item-name"><a class="enum" href="enum.ClassSetBinaryOpKind.html" title="enum regex_syntax::ast::ClassSetBinaryOpKind">ClassSetBinaryOpKind</a></div><div class="desc docblock-short">The type of a Unicode character class set operation.</div></li><li><div class="item-name"><a class="enum" href="enum.ClassSetItem.html" title="enum regex_syntax::ast::ClassSetItem">ClassSetItem</a></div><div class="desc docblock-short">A single component of a character class set.</div></li><li><div class="item-name"><a class="enum" href="enum.ClassUnicodeKind.html" title="enum regex_syntax::ast::ClassUnicodeKind">ClassUnicodeKind</a></div><div class="desc docblock-short">The available forms of Unicode character classes.</div></li><li><div class="item-name"><a class="enum" href="enum.ClassUnicodeOpKind.html" title="enum regex_syntax::ast::ClassUnicodeOpKind">ClassUnicodeOpKind</a></div><div class="desc docblock-short">The type of op used in a Unicode character class.</div></li><li><div class="item-name"><a class="enum" href="enum.ErrorKind.html" title="enum regex_syntax::ast::ErrorKind">ErrorKind</a></div><div class="desc docblock-short">The type of an error that occurred while building an AST.</div></li><li><div class="item-name"><a class="enum" href="enum.Flag.html" title="enum regex_syntax::ast::Flag">Flag</a></div><div class="desc docblock-short">A single flag.</div></li><li><div class="item-name"><a class="enum" href="enum.FlagsItemKind.html" title="enum regex_syntax::ast::FlagsItemKind">FlagsItemKind</a></div><div class="desc docblock-short">The kind of an item in a group of flags.</div></li><li><div class="item-name"><a class="enum" href="enum.GroupKind.html" title="enum regex_syntax::ast::GroupKind">GroupKind</a></div><div class="desc docblock-short">The kind of a group.</div></li><li><div class="item-name"><a class="enum" href="enum.HexLiteralKind.html" title="enum regex_syntax::ast::HexLiteralKind">HexLiteralKind</a></div><div class="desc docblock-short">The type of a Unicode hex literal.</div></li><li><div class="item-name"><a class="enum" href="enum.LiteralKind.html" title="enum regex_syntax::ast::LiteralKind">LiteralKind</a></div><div class="desc docblock-short">The kind of a single literal expression.</div></li><li><div class="item-name"><a class="enum" href="enum.RepetitionKind.html" title="enum regex_syntax::ast::RepetitionKind">RepetitionKind</a></div><div class="desc docblock-short">The kind of a repetition operator.</div></li><li><div class="item-name"><a class="enum" href="enum.RepetitionRange.html" title="enum regex_syntax::ast::RepetitionRange">RepetitionRange</a></div><div class="desc docblock-short">A range repetition operator.</div></li><li><div class="item-name"><a class="enum" href="enum.SpecialLiteralKind.html" title="enum regex_syntax::ast::SpecialLiteralKind">SpecialLiteralKind</a></div><div class="desc docblock-short">The typ