mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2026-03-12 20:00:31 +00:00
23 lines
10 KiB
HTML
23 lines
10 KiB
HTML
<!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="This is the actual “grammar” of the Rust language."><title>parser::grammar - 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-77263533.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.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.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"><!--[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="#">Module grammar</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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module grammar</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate parser</a></h2></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"><div class="rustdoc-breadcrumbs"><a href="../index.html">parser</a></div><h1>Module <span>grammar</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/grammar.rs.html#1-439">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This is the actual “grammar” of the Rust language.</p>
|
|
<p>Each function in this module and its children corresponds
|
|
to a production of the formal grammar. Submodules roughly
|
|
correspond to different <em>areas</em> of the grammar. By convention,
|
|
each submodule starts with <code>use super::*</code> import and exports
|
|
“public” productions via <code>pub(super)</code>.</p>
|
|
<p>See docs for <a href="../parser/struct.Parser.html" title="struct parser::parser::Parser"><code>Parser</code></a> to learn about API,
|
|
available to the grammar, and see docs for <a href="../event/enum.Event.html" title="enum parser::event::Event"><code>Event</code></a>
|
|
to learn how this actually manages to produce parse trees.</p>
|
|
<p>Code in this module also contains inline tests, which start with
|
|
<code>// test name-of-the-test</code> comment and look like this:</p>
|
|
<div class="example-wrap"><pre class="language-text"><code>// test function_with_zero_parameters
|
|
// fn foo() {}</code></pre></div>
|
|
<p>After adding a new inline-test, run <code>cargo test -p xtask</code> to
|
|
extract it as a standalone text-fixture into
|
|
<code>crates/syntax/test_data/parser/</code>, and run <code>cargo test</code> once to
|
|
create the “gold” value.</p>
|
|
<p>Coding convention: rules like <code>where_clause</code> always produce either a
|
|
node or an error, rules like <code>opt_where_clause</code> may produce nothing.
|
|
Non-opt rules typically start with <code>assert!(p.at(FIRST_TOKEN))</code>, the
|
|
caller is responsible for branching on the first token.</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="attributes/index.html" title="mod parser::grammar::attributes">attributes</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="entry/index.html" title="mod parser::grammar::entry">entry</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="expressions/index.html" title="mod parser::grammar::expressions">expressions</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="generic_args/index.html" title="mod parser::grammar::generic_args">generic_<wbr>args</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="generic_params/index.html" title="mod parser::grammar::generic_params">generic_<wbr>params</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="items/index.html" title="mod parser::grammar::items">items</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="params/index.html" title="mod parser::grammar::params">params</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="paths/index.html" title="mod parser::grammar::paths">paths</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="patterns/index.html" title="mod parser::grammar::patterns">patterns</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="types/index.html" title="mod parser::grammar::types">types</a><span title="Restricted Visibility"> 🔒</span> </dt></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.BlockLike.html" title="enum parser::grammar::BlockLike">Block<wbr>Like</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.PATH_NAME_REF_KINDS.html" title="constant parser::grammar::PATH_NAME_REF_KINDS">PATH_<wbr>NAME_<wbr>REF_<wbr>KINDS</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.PATH_NAME_REF_OR_INDEX_KINDS.html" title="constant parser::grammar::PATH_NAME_REF_OR_INDEX_KINDS">PATH_<wbr>NAME_<wbr>REF_<wbr>OR_<wbr>INDEX_<wbr>KINDS</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.VISIBILITY_FIRST.html" title="constant parser::grammar::VISIBILITY_FIRST">VISIBILITY_<wbr>FIRST</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.abi.html" title="fn parser::grammar::abi">abi</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.delimited.html" title="fn parser::grammar::delimited">delimited</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>The <code>parser</code> passed this is required to at least consume one token if it returns <code>true</code>.
|
|
If the <code>parser</code> returns false, parsing will stop.</dd><dt><a class="fn" href="fn.error_block.html" title="fn parser::grammar::error_block">error_<wbr>block</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.error_let_stmt.html" title="fn parser::grammar::error_let_stmt">error_<wbr>let_<wbr>stmt</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.lifetime.html" title="fn parser::grammar::lifetime">lifetime</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.name.html" title="fn parser::grammar::name">name</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.name_r.html" title="fn parser::grammar::name_r">name_r</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.name_ref_mod_path.html" title="fn parser::grammar::name_ref_mod_path">name_<wbr>ref_<wbr>mod_<wbr>path</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.name_ref_mod_path_or_index.html" title="fn parser::grammar::name_ref_mod_path_or_index">name_<wbr>ref_<wbr>mod_<wbr>path_<wbr>or_<wbr>index</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.name_ref_or_index.html" title="fn parser::grammar::name_ref_or_index">name_<wbr>ref_<wbr>or_<wbr>index</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.name_ref_or_self.html" title="fn parser::grammar::name_ref_or_self">name_<wbr>ref_<wbr>or_<wbr>self</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.name_ref_or_upper_self.html" title="fn parser::grammar::name_ref_or_upper_self">name_<wbr>ref_<wbr>or_<wbr>upper_<wbr>self</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.opt_rename.html" title="fn parser::grammar::opt_rename">opt_<wbr>rename</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.opt_ret_type.html" title="fn parser::grammar::opt_ret_type">opt_<wbr>ret_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.opt_visibility.html" title="fn parser::grammar::opt_visibility">opt_<wbr>visibility</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.reparser.html" title="fn parser::grammar::reparser">reparser</a><span title="Restricted Visibility"> 🔒</span> </dt></dl></section></div></main></body></html> |