itsscb/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2026-03-06 19:39:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
rust-analyzer/parser/index.html
github-merge-queue[bot] 416ac1ea11 deploy: 0c746f699034e70e1c3f11036b8c2895a0b1071c
2026-02-22 17:06:28 +00:00

17 lines
14 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="The Rust parser."><title>parser - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="parser" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Crate parser</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../parser/index.html">parser</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#modules">Crate Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#macros" title="Macros">Macros</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>parser</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/parser/lib.rs.html#1-201">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The Rust parser.</p>
<p>NOTE: The crate is undergoing refactors, don’t believe everything the docs
say :-)</p>
<p>The parser doesn’t know about concrete representation of tokens
and syntax trees. Abstract <a href="struct.Input.html" title="struct parser::Input"><code>Input</code></a> and <a href="struct.Output.html" title="struct parser::Output"><code>Output</code></a> traits are
used to provide tokens instead. As a consequence, this crate does
not contain a lexer.</p>
<p>The <a href="parser/struct.Parser.html" title="struct parser::parser::Parser"><code>Parser</code></a> struct from the <a href="parser/struct.Parser.html" title="struct parser::parser::Parser"><code>parser</code></a> module is a cursor into the
sequence of tokens. Parsing routines use <a href="parser/struct.Parser.html" title="struct parser::parser::Parser"><code>Parser</code></a> to inspect current
state and advance the parsing.</p>
<p>The actual parsing happens in the <a href="grammar/index.html" title="mod parser::grammar"><code>grammar</code></a> module.</p>
<p>Tests for this crate live in the <code>syntax</code> crate.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="event/index.html" title="mod parser::event">event</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>This module provides a way to construct a <code>File</code>.
It is intended to be completely decoupled from the
parser, so as to allow to evolve the tree representation
and the parser algorithm independently.</dd><dt><a class="mod" href="frontmatter/index.html" title="mod parser::frontmatter">frontmatter</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="grammar/index.html" title="mod parser::grammar">grammar</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>This is the actual “grammar” of the Rust language.</dd><dt><a class="mod" href="input/index.html" title="mod parser::input">input</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>See <a href="struct.Input.html" title="struct parser::Input"><code>Input</code></a>.</dd><dt><a class="mod" href="lexed_str/index.html" title="mod parser::lexed_str">lexed_<wbr>str</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Lexing <code>&amp;str</code> into a sequence of Rust tokens.</dd><dt><a class="mod" href="output/index.html" title="mod parser::output">output</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>See <a href="struct.Output.html" title="struct parser::Output"><code>Output</code></a></dd><dt><a class="mod" href="parser/index.html" title="mod parser::parser">parser</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>See <a href="parser/struct.Parser.html" title="struct parser::parser::Parser"><code>Parser</code></a>.</dd><dt><a class="mod" href="shortcuts/index.html" title="mod parser::shortcuts">shortcuts</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Shortcuts that span lexer/parser abstraction.</dd><dt><a class="mod" href="syntax_kind/index.html" title="mod parser::syntax_kind">syntax_<wbr>kind</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Defines <a href="enum.SyntaxKind.html" title="enum parser::SyntaxKind"><code>SyntaxKind</code></a> – a fieldless enum of all possible syntactic
constructs of the Rust language.</dd><dt><a class="mod" href="token_set/index.html" title="mod parser::token_set">token_<wbr>set</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>A bit-set of <code>SyntaxKind</code>s.</dd></dl><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><dl class="item-table"><dt><a class="macro" href="macro.T.html" title="macro parser::T">T</a></dt><dd><code>T![]</code></dd><dt><a class="macro" href="macro.T_.html" title="macro parser::T_">T_</a></dt><dd><code>T![]</code></dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Input.html" title="struct parser::Input">Input</a></dt><dd>Input for the parser – a sequence of tokens.</dd><dt><a class="struct" href="struct.LexedStr.html" title="struct parser::LexedStr">Lexed<wbr>Str</a></dt><dt><a class="struct" href="struct.Output.html" title="struct parser::Output">Output</a></dt><dd>Output of the parser – a DFS traversal of a concrete syntax tree.</dd><dt><a class="struct" href="struct.Reparser.html" title="struct parser::Reparser">Reparser</a></dt><dd>A parsing function for a specific braced-block.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Edition.html" title="enum parser::Edition">Edition</a></dt><dt><a class="enum" href="enum.PrefixEntryPoint.html" title="enum parser::PrefixEntryPoint">Prefix<wbr>Entry<wbr>Point</a></dt><dd>Parse a prefix of the input as a given syntactic construct.</dd><dt><a class="enum" href="enum.Step.html" title="enum parser::Step">Step</a></dt><dt><a class="enum" href="enum.StrStep.html" title="enum parser::StrStep">StrStep</a></dt><dt><a class="enum" href="enum.SyntaxKind.html" title="enum parser::SyntaxKind">Syntax<wbr>Kind</a></dt><dd>The kind of syntax node, e.g. <code>IDENT</code>, <code>USE_KW</code>, or <code>STRUCT</code>.</dd><dt><a class="enum" href="enum.TopEntryPoint.html" title="enum parser::TopEntryPoint">TopEntry<wbr>Point</a></dt><dd>Parse the whole of the input as a given syntactic construct.</dd></dl><script type="text/json" id="notable-traits-data">{"&<Range<usize> as SliceIndex<ByteStr>>::Output":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;<div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/range/trait.Step.html\" title=\"trait core::iter::range::Step\">Step</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = A;</div>","&<Range<usize> as SliceIndex<str>>::Output":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;<div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/range/trait.Step.html\" title=\"trait core::iter::range::Step\">Step</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = A;</div>","&mut <Range<usize> as SliceIndex<ByteStr>>::Output":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;<div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/range/trait.Step.html\" title=\"trait core::iter::range::Step\">Step</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = A;</div>","&mut <Range<usize> as SliceIndex<str>>::Output":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;<div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/range/trait.Step.html\" title=\"trait core::iter::range::Step\">Step</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = A;</div>","Range<Idx>":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;<div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/range/trait.Step.html\" title=\"trait core::iter::range::Step\">Step</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = A;</div>","Range<T>":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/core/ops/range/struct.Range.html\" title=\"struct core::ops::range::Range\">Range</a>&lt;A&gt;<div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/iter/range/trait.Step.html\" title=\"trait core::iter::range::Step\">Step</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.93.1/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = A;</div>"}</script></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink