rust-analyzer/parser/index.html
github-merge-queue[bot] b3304c76bb deploy: fa19df2d0e
2025-09-04 09:50:06 +00:00

12 lines
No EOL
5.6 KiB
HTML
Raw Permalink 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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-84e720fa.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.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../static.files/storage-4e99c027.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-fd3af306.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><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="#macros">Crate Items</a></h3><ul class="block"><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"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>parser</span><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-197">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, dont believe everything the docs
say :-)</p>
<p>The parser doesnt know about concrete representation of tokens and syntax
trees. Abstract [<code>TokenSource</code>] and [<code>TreeSink</code>] traits are used instead. As
a consequence, this crate does not contain a lexer.</p>
<p>The <a href="crate::parser::Parser"><code>Parser</code></a> struct from the <a href="crate::parser::Parser"><code>parser</code></a> module is a cursor into the
sequence of tokens. Parsing routines use <a href="crate::parser::Parser"><code>Parser</code></a> to inspect current
state and advance the parsing.</p>
<p>The actual parsing happens in the [<code>grammar</code>] module.</p>
<p>Tests for this crate live in the <code>syntax</code> crate.</p>
</div></details><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><dt><a class="macro" href="macro.T_.html" title="macro parser::T_">T_</a></dt></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></section></div></main></body></html>